Skip to main content

Create backup (V2)

Back up the specified cluster or collection. Note that this API only applies to dedicated clusters.

POST
/v2/clusters/{CLUSTER_ID}/backups/create
Base URL

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

https://api.cloud.zilliz.com

📘Notes

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

export BASE_URL="https://api.cloud.zilliz.com"
Parameters
Authorizationstringheaderrequired

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

Example Value: Bearer {{TOKEN}}
CLUSTER_IDstringpathrequired

The ID of the cluster that needs to be backed up.

Example Value: inxx-xxxxxxxxxxxxxxx
Request Bodyapplication/json
backupTypestringrequired

The type of the resources to be backed up.

dbCollectionsarray

The collections that need to be backed up. This is mandatory when the backupType is set to COLLECTION. Note that all collections listed in this field must belong to the same database.

[]dbCollectionsobject

The collection information.

dbNamestring

The name of the database containing the collections listed in the collectionNames field.

collectionNamesarray

The names of the collections to be backed up.

[]collectionNamesstring

A collection name

crossRegionCopiesarray

The list of cloud regions to which the backup will be copied. Note that Zilliz Cloud will create a backup in the same region as the cluster by default, so you only need to specify the regions where you want to copy the backup to. Each entry in the list results in one copy of the permanent backup being created in the specified region.

[]crossRegionCopiesobject

Information about the target cloud region to which the backup will be copied.

regionIdstring

The ID of the target cloud region to which the backup will be copied.

Example Value: aws-us-west-2
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "backupType": "CLUSTER"
}'
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "backupType": "COLLECTION",
    "dbCollections": [
        {
            "dbName": "my_database",
            "collectionNames": [
                "collection_1",
                "collection_2"
            ]
        }
    ]
}'
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "backupType": "COLLECTION",
    "dbCollections": [
        {
            "dbName": "my_database",
            "collectionNames": [
                "collection_1",
                "collection_2"
            ]
        }
    ],
    "crossRegionCopies": [
        {
            "regionId": "aws-us-west-2"
        },
        {
            "regionId": "aws-us-east-1"
        }
    ]
}'
Responses200 - application/json
codeinteger

Response code

dataobject
backupIdstring

The ID of the backup that has been created.

Example Value: backupx_xxxxxxxxxxxxxxx
backupNamestring

The name of the backup that has been created.

jobIdstring

The ID of the asynchronous job that has created this backup.

Example Value: job-xxxxxxxxxxxxxxxxxxxx

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "backupId": "backupx_xxxxxxxxxxxxxxx",
        "backupName": "Dedicated_01",
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx"
    }
}