Skip to main content

Export Snapshot (V2)

On Request

Exports a collection snapshot to the configured object storage.

POST/v2/vectordb/jobs/snapshot/export
Connection Endpoint

The base URL for this API is in the following format:

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

📘Notes
  • Use the cluster endpoint if you are using serving clusters.

    • Free & Serverless

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated

      https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

shell
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
Parameters
Authorizationstringheader

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
dbNamestring

The name of the database that contains the collection.

collectionNamestringrequired

The name of the collection to snapshot.

snapshotNamestringrequired

The name of the snapshot.

targetS3Pathstringrequired

The root path in S3-compatible object storage under which Milvus writes the exported snapshot data and metadata. It must be a writable URI such as s3://bucket-name/export-root. Milvus appends snapshot-specific metadata paths below this root; the response returns the generated snapshotMetadataURI.

externalSpecstring

Optional JSON configuration for external object storage. When targetS3Path points to storage outside the Milvus-managed bucket, pass an extfs object to override how Milvus accesses that bucket. Supported JSON fields:

  • format: "parquet", "lance-table", or "vortex"; defaults to "parquet" when omitted or when the whole value is empty.
  • columns: optional array of column names to load.
  • extfs: optional map of object-storage overrides. Allowed keys are cloud_provider, region, use_iam, use_ssl, use_virtual_host, iam_endpoint, storage_type, ssl_ca_cert, access_key_id, and access_key_value.

Requirements:

  • The value must be valid JSON.
  • format must be one of the supported values above.
  • extfs keys are allowlisted; unsupported keys are rejected.
  • use_iam, use_ssl, and use_virtual_host must be the strings "true" or "false".
  • Use extfs only when the target bucket requires credentials or connectivity settings different from the Milvus-managed bucket. Omit externalSpec or pass an empty string to use the default Milvus-managed storage.

Example: {"format":"parquet","extfs":{"cloud_provider":"aws","region":"us-west-2","use_iam":"true"}}.

bash
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/jobs/snapshot/export" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "default",
    "collectionName": "my_collection",
    "snapshotName": "snapshot_2026_01",
    "targetS3Path": "s3://bucket-name/export-root",
    "externalSpec": ""
}'
Responses200 OK - application/json

Exports a collection snapshot to the configured object storage.

codeintegerrequired

Response code.

dataobjectrequired
snapshotMetadataURIstringrequired

The object-storage URI of the exported snapshot metadata.

codeintegerrequired

Response code.

messagestringrequired

Error message.

Successjson
{
    "code": 0,
    "data": {
        "snapshotMetadataURI": "s3://bucket/snapshots/snapshot_2026_01"
    }
}
Ctrl I