{
"version": "2026-03-25",
"minCliVersion": "1.0.0",
"endpoint": "https://api.cloud.zilliz.com",
"auth": {
"auth0_domain": "https://zilliz-cloud-prod.us.auth0.com",
"client_id": "BCldqrRagUacn9io7vsP3NWRm2vMhelz",
"login_api": "https://cloud-service.cloud.zilliz.com"
},
"resources": {
"cluster": {
"description": "Create, scale, and manage cloud clusters.",
"operations": {
"list": {
"description": "List all clusters.",
"http": {
"method": "GET",
"path": "/v2/clusters"
},
"params": [
{
"name": "pageSize",
"type": "integer",
"cli": "--page-size",
"description": "items per page"
},
{
"name": "currentPage",
"type": "integer",
"cli": "--page",
"description": "page number"
}
],
"output": {
"dataField": "data",
"columns": ["clusterName", "clusterId", "description", "regionId", "cuType", "plan", "cuSize", "status"],
"colorMap": {
"status": {
"RUNNING": "green",
"CREATING": "cyan",
"RESUMING": "cyan",
"SUSPENDED": "yellow",
"ABNORMAL": "red",
"DELETING": "red",
"*": "white"
}
}
},
"pagination": {
"pageSizeParam": "pageSize",
"pageParam": "currentPage",
"countField": "count",
"dataField": "clusters",
"defaultPageSize": 100
},
"examples": [
"# List all clusters",
"zilliz cluster list",
"",
"# Fetch all pages",
"zilliz cluster list --all"
]
},
"describe": {
"description": "Get details of a cluster.",
"http": {
"method": "GET",
"path": "/v2/clusters/{clusterId}"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID (e.g. in01-xxxxxxxxxxxx)"
}
],
"examples": [
"zilliz cluster describe --cluster-id in01-xxxxxxxxxxxx"
]
},
"modify": {
"description": "Modify cluster configuration (scale CU or replicas).",
"http": {
"method": "POST",
"path": "/v2/clusters/{clusterId}/modify"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID to modify"
},
{
"name": "cuSize",
"type": "integer",
"cli": "--cu-size",
"description": "number of compute units"
},
{
"name": "replica",
"type": "integer",
"cli": "--replica",
"description": "number of replicas"
}
],
"bodyParam": "--body",
"examples": [
"# Scale to 2 CUs",
"zilliz cluster modify --cluster-id in01-xxxxxxxxxxxx --cu-size 2",
"",
"# Set replicas",
"zilliz cluster modify --cluster-id in01-xxxxxxxxxxxx --replica 2"
]
},
"suspend": {
"description": "Suspend a running cluster. Suspending stops compute charges.",
"http": {
"method": "POST",
"path": "/v2/clusters/{clusterId}/suspend"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID to suspend"
}
],
"examples": [
"zilliz cluster suspend --cluster-id in01-xxxxxxxxxxxx"
]
},
"resume": {
"description": "Resume a suspended cluster.",
"http": {
"method": "POST",
"path": "/v2/clusters/{clusterId}/resume"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID to resume"
}
],
"examples": [
"zilliz cluster resume --cluster-id in01-xxxxxxxxxxxx"
]
},
"delete": {
"description": "Delete a cluster. This action is irreversible.",
"http": {
"method": "DELETE",
"path": "/v2/clusters/{clusterId}/drop"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID to delete"
}
],
"examples": [
"zilliz cluster delete --cluster-id in01-xxxxxxxxxxxx",
"",
"# Skip confirmation prompt",
"zilliz cluster delete --cluster-id in01-xxxxxxxxxxxx -y"
]
},
"providers": {
"description": "List all cloud providers (aws, gcp, azure).",
"http": {
"method": "GET",
"path": "/v2/clouds"
},
"params": [],
"examples": [
"zilliz cluster providers"
]
},
"regions": {
"description": "List available regions for a cloud provider.",
"http": {
"method": "GET",
"path": "/v2/regions"
},
"params": [
{
"name": "cloudId",
"type": "string",
"cli": "--cloud-id",
"description": "cloud provider",
"choices": [
"aws",
"gcp",
"azure"
]
}
],
"examples": [
"# List all regions",
"zilliz cluster regions",
"",
"# List AWS regions only",
"zilliz cluster regions --cloud-id aws"
]
}
}
},
"project": {
"description": "Create and manage projects.",
"operations": {
"create": {
"description": "Create a new project.",
"http": {
"method": "POST",
"path": "/v2/projects"
},
"params": [
{
"name": "projectName",
"type": "string",
"required": true,
"cli": "--name",
"description": "project name"
},
{
"name": "plan",
"type": "string",
"required": true,
"cli": "--plan",
"description": "subscription plan",
"choices": [
"Standard",
"Enterprise",
"BusinessCritical"
]
}
],
"examples": [
"zilliz project create --name my-project --plan Standard"
]
},
"list": {
"description": "List all projects.",
"http": {
"method": "GET",
"path": "/v2/projects"
},
"params": [],
"examples": [
"zilliz project list"
]
},
"describe": {
"description": "Get details of a project.",
"http": {
"method": "GET",
"path": "/v2/projects/{projectId}"
},
"params": [
{
"name": "projectId",
"type": "string",
"required": true,
"cli": "--project-id",
"position": "path",
"description": "project ID"
}
],
"examples": [
"zilliz project describe --project-id proj-xxxxxxxxxxxx"
]
},
"upgrade": {
"description": "Upgrade project plan.",
"http": {
"method": "PATCH",
"path": "/v2/projects/{projectId}/plan"
},
"params": [
{
"name": "projectId",
"type": "string",
"required": true,
"cli": "--project-id",
"position": "path",
"description": "project ID"
},
{
"name": "plan",
"type": "string",
"required": true,
"cli": "--plan",
"description": "target plan",
"choices": [
"Standard",
"Enterprise",
"BusinessCritical"
]
}
],
"examples": [
"zilliz project upgrade --project-id proj-xxxxxxxxxxxx --plan BusinessCritical"
]
}
}
},
"backup": {
"description": "Create, restore, and manage backups.",
"operations": {
"create": {
"description": "Create a backup for a cluster.",
"http": {
"method": "POST",
"path": "/v2/clusters/{clusterId}/backups/create"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name (for collection-level backup)"
},
{
"name": "collectionName",
"type": "string",
"cli": "--collection",
"description": "collection name (omit for full cluster backup)"
},
{
"name": "backupType",
"type": "string",
"cli": "--backup-type",
"description": "backup type (default: CLUSTER, auto-set to COLLECTION when --collection is given)",
"choices": ["CLUSTER", "COLLECTION"]
}
],
"bodyDefaults": {
"backupType": "CLUSTER"
},
"bodyTransform": {
"infer": {
"backupType": {
"value": "COLLECTION",
"when": "collectionName"
}
},
"compose": {
"dbCollections": {
"template": [
{
"dbName": "{dbName}",
"collectionNames": [
"{collectionName}"
]
}
],
"when": "collectionName",
"consume": [
"dbName",
"collectionName"
]
}
}
},
"bodyParam": "--body",
"examples": [
"# Full cluster backup (interactive mode)",
"zilliz backup create",
"",
"# Full cluster backup",
"zilliz backup create --cluster-id in01-xxxxxxxxxxxx",
"",
"# Collection-level backup (auto-detects COLLECTION type)",
"zilliz backup create --cluster-id in01-xxxxxxxxxxxx --database default --collection my_col"
]
},
"list": {
"description": "List all backups.",
"http": {
"method": "GET",
"path": "/v2/backups"
},
"params": [
{
"name": "projectId",
"type": "string",
"cli": "--project-id",
"description": "filter by project ID"
},
{
"name": "clusterId",
"type": "string",
"cli": "--cluster-id",
"description": "filter by cluster ID"
},
{
"name": "creationMethod",
"type": "string",
"cli": "--creation-method",
"description": "filter by creation method",
"choices": [
"MANUAL",
"AUTO"
]
},
{
"name": "backupType",
"type": "string",
"cli": "--backup-type",
"description": "filter by backup type",
"choices": [
"CLUSTER",
"COLLECTION"
]
},
{
"name": "pageSize",
"type": "integer",
"cli": "--page-size",
"description": "items per page"
},
{
"name": "currentPage",
"type": "integer",
"cli": "--page",
"description": "page number"
}
],
"pagination": {
"pageSizeParam": "pageSize",
"pageParam": "currentPage",
"countField": "count",
"dataField": "backups",
"defaultPageSize": 100
},
"examples": [
"# List all backups",
"zilliz backup list",
"",
"# List backups for a specific cluster",
"zilliz backup list --cluster-id in01-xxxxxxxxxxxx"
]
},
"describe": {
"description": "Get details of a backup.",
"http": {
"method": "GET",
"path": "/v2/clusters/{clusterId}/backups/{backupId}"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID"
},
{
"name": "backupId",
"type": "string",
"required": true,
"cli": "--backup-id",
"position": "path",
"description": "backup ID"
}
],
"examples": [
"zilliz backup describe --cluster-id in01-xxxx --backup-id backup-xxxx"
]
},
"delete": {
"description": "Delete a backup.",
"http": {
"method": "DELETE",
"path": "/v2/clusters/{clusterId}/backups/{backupId}"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID"
},
{
"name": "backupId",
"type": "string",
"required": true,
"cli": "--backup-id",
"position": "path",
"description": "backup ID to delete"
}
],
"examples": [
"zilliz backup delete --cluster-id in01-xxxx --backup-id backup-xxxx"
]
},
"export": {
"description": "Export a backup to external storage.",
"http": {
"method": "POST",
"path": "/v2/clusters/{clusterId}/backups/{backupId}/export"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID"
},
{
"name": "backupId",
"type": "string",
"required": true,
"cli": "--backup-id",
"position": "path",
"description": "backup ID"
},
{
"name": "integrationId",
"type": "string",
"required": true,
"cli": "--integration-id",
"description": "storage integration ID"
},
{
"name": "directory",
"type": "string",
"cli": "--directory",
"description": "target directory in external storage"
}
],
"examples": [
"zilliz backup export --cluster-id in01-xxxx --backup-id backup-xxxx --integration-id integ-xxxx"
]
},
"restore-cluster": {
"description": "Restore a backup to a new cluster.",
"http": {
"method": "POST",
"path": "/v2/clusters/{clusterId}/backups/{backupId}/restoreCluster"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "source cluster ID"
},
{
"name": "backupId",
"type": "string",
"required": true,
"cli": "--backup-id",
"position": "path",
"description": "backup ID to restore"
},
{
"name": "projectId",
"type": "string",
"required": true,
"cli": "--project-id",
"description": "target project ID"
},
{
"name": "clusterName",
"type": "string",
"required": true,
"cli": "--name",
"description": "new cluster name"
},
{
"name": "cuSize",
"type": "integer",
"required": true,
"cli": "--cu-size",
"description": "compute units for new cluster"
},
{
"name": "collectionStatus",
"type": "string",
"required": true,
"cli": "--collection-status",
"description": "collection state after restore",
"choices": [
"LOADED",
"NOT_LOADED"
]
}
],
"examples": [
"# Restore with collections loaded",
"zilliz backup restore-cluster --cluster-id in01-xxxx --backup-id backup-xxxx --project-id proj-xxxx --name restored --cu-size 1 --collection-status LOADED"
]
},
"restore-collection": {
"description": "Restore specific collections from a backup.",
"http": {
"method": "POST",
"path": "/v2/clusters/{clusterId}/backups/{backupId}/restoreCollection"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "source cluster ID"
},
{
"name": "backupId",
"type": "string",
"required": true,
"cli": "--backup-id",
"position": "path",
"description": "backup ID"
},
{
"name": "destClusterId",
"type": "string",
"required": true,
"cli": "--dest-cluster-id",
"description": "destination cluster ID"
}
],
"bodyParam": "--body",
"examples": [
"zilliz backup restore-collection --cluster-id in01-xxxx --backup-id backup-xxxx --dest-cluster-id in01-yyyy"
]
},
"describe-policy": {
"description": "Describe backup policy for a cluster.",
"http": {
"method": "GET",
"path": "/v2/clusters/{clusterId}/backups/policy"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID"
}
],
"examples": [
"zilliz backup describe-policy --cluster-id in01-xxxxxxxxxxxx"
]
},
"update-policy": {
"description": "Update backup policy for a cluster.",
"http": {
"method": "POST",
"path": "/v2/clusters/{clusterId}/backups/policy"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"position": "path",
"description": "cluster ID"
},
{
"name": "enabled",
"type": "boolean",
"required": true,
"cli": "--auto-backup",
"description": "turn auto-backup on or off"
},
{
"name": "frequency",
"type": "string",
"cli": "--frequency",
"description": "daily | weekdays | weekends | 1-7 (1=Mon, 7=Sun) e.g. 1,3,5",
"requiredWhen": { "enabled": true },
"transform": {
"type": "dayOfWeek"
}
},
{
"name": "startTime",
"type": "string",
"cli": "--start-time",
"description": "start hour in UTC, e.g. 02:00",
"requiredWhen": { "enabled": true },
"transform": {
"type": "timeWindow",
"windowHours": 2
}
},
{
"name": "retentionDays",
"type": "integer",
"cli": "--retention-days",
"description": "days to retain backups (1-30)",
"requiredWhen": { "enabled": true }
}
],
"bodyDefaults": {
"crossRegionCopies": []
},
"bodyParam": "--body",
"examples": [
"# Enable daily backup at 2am UTC with 7-day retention",
"zilliz backup update-policy --cluster-id in01-xxxx --auto-backup true --frequency daily --start-time 02:00 --retention-days 7",
"",
"# Enable backup on Mon/Wed/Fri at 3am UTC",
"zilliz backup update-policy --cluster-id in01-xxxx --auto-backup true --frequency 1,3,5 --start-time 03:00-05:00 --retention-days 14",
"",
"# Disable auto-backup",
"zilliz backup update-policy --cluster-id in01-xxxx --auto-backup false"
]
}
}
},
"import": {
"description": "Import data from cloud storage.",
"operations": {
"start": {
"description": "Start a data import job.",
"http": {
"method": "POST",
"path": "/v2/vectordb/jobs/import/create"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"description": "target cluster ID"
},
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "target collection name"
}
],
"bodyParam": "--body",
"examples": [
"# Import from S3",
"zilliz import start --cluster-id in01-xxxx --collection my_col --body '{\"files\": [[\"s3://bucket/data.json\"]]}'",
"",
"# Import using a JSON file",
"zilliz import start --cluster-id in01-xxxx --collection my_col --body file://import-spec.json"
]
},
"list": {
"description": "List import jobs for a cluster.",
"http": {
"method": "POST",
"path": "/v2/vectordb/jobs/import/list"
},
"params": [
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"description": "cluster ID"
},
{
"name": "pageSize",
"type": "integer",
"cli": "--page-size",
"description": "items per page"
},
{
"name": "currentPage",
"type": "integer",
"cli": "--page",
"description": "page number"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz import list --cluster-id in01-xxxxxxxxxxxx"
]
},
"status": {
"description": "Get status of an import job.",
"http": {
"method": "POST",
"path": "/v2/vectordb/jobs/import/getProgress"
},
"params": [
{
"name": "jobId",
"type": "string",
"required": true,
"cli": "--job-id",
"description": "import job ID"
},
{
"name": "clusterId",
"type": "string",
"required": true,
"cli": "--cluster-id",
"description": "cluster ID"
}
],
"examples": [
"zilliz import status --job-id job-xxxx --cluster-id in01-xxxxxxxxxxxx"
]
}
}
},
"volume": {
"description": "Manage data volumes.",
"operations": {
"create": {
"description": "Create a new volume.",
"http": {
"method": "POST",
"path": "/v2/volumes/create"
},
"params": [
{
"name": "projectId",
"type": "string",
"required": true,
"cli": "--project-id",
"description": "project ID"
},
{
"name": "regionId",
"type": "string",
"required": true,
"cli": "--region",
"description": "cloud region (e.g. aws-us-west-2)"
},
{
"name": "volumeName",
"type": "string",
"required": true,
"cli": "--name",
"description": "volume name"
}
],
"examples": [
"zilliz volume create --project-id proj-xxxx --region aws-us-west-2 --name my-volume"
]
},
"list": {
"description": "List all volumes in a project.",
"http": {
"method": "GET",
"path": "/v2/volumes"
},
"params": [
{
"name": "projectId",
"type": "string",
"required": true,
"cli": "--project-id",
"description": "project ID"
},
{
"name": "pageSize",
"type": "integer",
"cli": "--page-size",
"description": "items per page"
},
{
"name": "currentPage",
"type": "integer",
"cli": "--page",
"description": "page number"
}
],
"pagination": {
"pageSizeParam": "pageSize",
"pageParam": "currentPage",
"countField": "count",
"dataField": "volumes",
"defaultPageSize": 100
},
"examples": [
"zilliz volume list --project-id proj-xxxxxxxxxxxx"
]
},
"delete": {
"description": "Delete a volume.",
"http": {
"method": "DELETE",
"path": "/v2/volumes/{volumeName}"
},
"params": [
{
"name": "volumeName",
"type": "string",
"required": true,
"cli": "--name",
"position": "path",
"description": "volume name to delete"
}
],
"examples": [
"zilliz volume delete --name my-volume"
]
}
}
},
"job": {
"description": "Query status of async Cloud Jobs.",
"operations": {
"describe": {
"description": "Get status of an async job (backup, restore, migration, import, etc.).",
"http": {
"method": "GET",
"path": "/v2/jobs/{jobId}"
},
"params": [
{
"name": "jobId",
"type": "string",
"required": true,
"cli": "--job-id",
"position": "path",
"description": "job ID (e.g. job-xxxxxxxxxxxxxxxxxxxx)"
}
],
"examples": [
"# Check the status of a job",
"zilliz job describe --job-id job-03e1eefbd82dmo2oeb8pe2",
"",
"# Output as JSON",
"zilliz job describe --job-id job-03e1eefbd82dmo2oeb8pe2 -o json"
]
}
}
},
"billing": {
"description": "View usage, invoices, and billing information.",
"operations": {}
}
}
}