Skip to main content

Create backup

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

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.

[]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

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": [
        {
            "collectionNames": [
                "medium_articles"
            ]
        }
    ]
}'
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"
    }
}