Give Feedback

dots.v2.vectorDatabases.byId().backups.byBackup_id().restore.post()

Generated on 27 Oct 2026 from DoTs version v1.21.0

Copy page as Markdown View page as Markdown

Usage

client.v2.vectorDatabases.byId(id).backups.byBackup_id(backup_id).restore.post(body: VectordbRestoreBackupRequest, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | VectordbRestoreBackupResponse>

Description

To restore a vector database from a backup, send a POST request to /v2/vector-databases/{id}/backups/{backup_id}/restore. The restore runs asynchronously; use the restore-status endpoint to monitor its progress.

Parameters

Path Parameters

id string required

Example: "example string"

Required. ID of the vector database.

backup_id string required

Example: "example string"

Required. ID of the backup to restore from.

Request Body

backupId string optional

Example: 123e4567-e89b-12d3-a456-426614174000

Required. ID of the backup to restore from.

id string optional

Example: example string

Required. ID of the vector database.

Request Sample

Show Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.vectorDatabases
    .byId("\"example string\"").backups
    .byBackup_id("\"example string\"").restore.post({
    backupId: "123e4567-e89b-12d3-a456-426614174000",
    id: "example string",
});

Response Example

Show Response Example

{
  "backup_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "example string"
}

More Information

See /v2/vector-databases/{id}/backups/{backup_id}/restore in the API reference for additional detail on responses, headers, parameters, and more.