Skip to content
MilvusNode SDK
Sections

Restore external snapshot

Markdown

Copy for agent

Connection and CORS help

Use HTTPS for remote clusters or HTTP on loopback. Requests go directly from your browser to the endpoint. When copying an authenticated cURL command, set MILVUS_TOKEN in your shell.

For cross-origin requests, configure the endpoint to answer OPTIONS and allow the docs origin, POST, Content-Type, and Authorization if you use a token. Try the copied cURL command to troubleshoot outside the browser.

POST/v2/vectordb/jobs/snapshot/restore_external

{
  "dbName": "default",
  "targetCollectionName": "books_restored",
  "snapshotMetadataURI": "s3://example-bucket/snapshots/books/manifest.json"
}

Example response

{
  "code": 0,
  "data": {
    "jobId": 123456789
  }
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/jobs/snapshot/restore_external' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "targetCollectionName": "books_restored",
  "snapshotMetadataURI": "s3://example-bucket/snapshots/books/manifest.json"
}'

Start a restore using snapshot metadata in external storage.

Request fields

dbName string
Database name. Operations on collections use default when omitted.
targetCollectionName string (required)
Collection name to use for the restored data.
snapshotMetadataURI string (required)
URI of the exported snapshot metadata.
externalSpec string
Serialized JSON specifying the external storage format and options.

See HttpClient.restoreExternalSnapshot for the Node.js SDK method.