Skip to main content

List Backups

List all AVAILABLE or CREATING backups. Note that this API only applies to dedicated clusters.

GET
/v2/backups
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}}
projectIdstringquery

The ID of the project to which the backup belongs.

clusterIdstringquery

The ID of the cluster to which the backup belongs.

creationMethodstringquery

Whether the backup is created manually or automatically.

backupTypestringquery

The type of resources contained in the backup file.

startTimestringquery

The time at which Zilliz Cloud starts to make this backup.

endTimestringquery

The time at which Zilliz Cloud finishes making this backup.

pageSizestringquery

The number of records to be displayed per page.

currentPagestringquery

The page number to be displayed.

export TOKEN="YOUR_API_KEY"

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

Response code.

dataobject

Response payload which is a list of backups.

countinteger

The total number of backups returned.

currentPageinteger

The current page number.

pageSizeinteger

The number of records per page.

backupsarray

A list of backups.

[]backupsobject

Inforamtion about a backup in detail.

projectIdstring

The ID of the project that holds the backup.

backupIdstring

The ID of the backup.

backupNamestring

The name of the backup.

backupTypestring

The type of resources contained in the backup.

creationMethodstring

Whether the backup is created manually or automatically.

sizeinteger

The size of the backup in bytes.

expireTimestring

The time at which the backup will be automatically deleted.

clusterIdstring

The ID of the cluster whose data has been backed up.

clusterNamestring

The name of the cluster whose data has been backed up.

createTimestring

The time at which the cluster has been created.

statusstring

The status of the backup.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "backups": [
            {
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxx",
                "backupId": "backupx_xxxxxxxxxxxxxxxx",
                "backupName": "Dedicated-01_backup1",
                "backupType": "CLUSTER",
                "creationMethod": "AUTO",
                "size": 112,
                "expireTime": "2024-08-30T16:49:50Z",
                "clusterId": "inxx-xxxxxxxxxxxxxx",
                "clusterName": "Dedicated-01",
                "createTime": "2024-07-30T16:49:50Z",
                "status": "AVAILABLE"
            }
        ]
    }
}