Skip to main content

Delete Backup

Delete the specified backup of a cluster. Note that this API only applies to dedicated clusters.

DELETE
/v2/clusters/{CLUSTER_ID}/backups/{BACKUP_ID}
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 whose backup is to be deleted.

Example Value: inxx-xxxxxxxxxxxxxxx
BACKUP_IDstringpathrequired

The ID of the backup to be deleted.

Example Value: Dedicated-01_backup3
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export BACKUP_ID="Dedicated-01_backup3"

curl --request DELETE \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload which is the information about the deleted backup.

backupIdstring

The ID of the backup that has been deleted.

Example Value: backupx_xxxxxxxxxxxxxxx
backupNamestring

The name of the backup that has been deleted.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "backupId": "backup1_1e9d15560e4f240",
        "backupName": "Dedicated-01_backup1"
    }
}