backup

name	backup
description	Use when the user wants to create, list, describe, delete, export, or restore backups, or manage backup policies on Zilliz Cloud.

Prerequisites

1. CLI installed and logged in (see setup skill).
2. No cluster context required -- backup operations use --cluster-id directly.

Commands Reference

Create a Backup

zilliz backup create --cluster-id <cluster-id>
# Optional:
#   --database <database-name>
#   --collection <collection-name>
#   --backup-type <CLUSTER|COLLECTION>
# Or use raw JSON: --body '{...}'

List Backups

zilliz backup list
# Optional:
#   --project-id <filter-by-project-id>
#   --cluster-id <filter-by-cluster-id>
#   --creation-method <MANUAL|AUTO>
#   --backup-type <CLUSTER|COLLECTION>
# Pagination: --page-size <n> --page <n>
# Fetch all pages: --all

Describe a Backup

zilliz backup describe --cluster-id <cluster-id> --backup-id <backup-id>

Delete a Backup

zilliz backup delete --cluster-id <cluster-id> --backup-id <backup-id-to-delete>

Export a Backup

zilliz backup export \
  --cluster-id <cluster-id> \
  --backup-id <backup-id> \
  --integration-id <storage-integration-id>
# Optional: --directory <directory>

Restore to a New Cluster

zilliz backup restore-cluster \
  --cluster-id <source-cluster-id> \
  --backup-id <backup-id-to-restore> \
  --project-id <target-project-id> \
  --name <new-cluster-name> \
  --cu-size <compute-units-for-new-cluster> \
  --collection-status <LOADED|NOT_LOADED>

Restore Specific Collections

zilliz backup restore-collection \
  --cluster-id <source-cluster-id> \
  --backup-id <backup-id> \
  --dest-cluster-id <destination-cluster-id>
# Or use raw JSON: --body '{"collections": [{"source": "col1", "target": "col1_restored"}]}'

Describe Backup Policy

zilliz backup describe-policy --cluster-id <cluster-id>

Update Backup Policy

zilliz backup update-policy --cluster-id <cluster-id> --auto-backup <true|false>
# Optional:
#   --frequency <frequency>
#   --start-time <start-time>
#   --retention-days <days-to-retain-backups>
# Or use raw JSON: --body '{...}'

Backup Policy Format

Frequency: daily | weekdays | weekends | 1-7 (1=Mon, 7=Sun), e.g. 1,3,5

Start time: HH:MM or HH:MM-HH:MM (time window), e.g. 02:00 or 03:00-05:00

Guidance

• The backup type is automatically derived: if --collection is provided, it's a COLLECTION backup; otherwise it's a CLUSTER backup.
• Backup creation, export, and restore operations are asynchronous. After starting, use backup describe to check progress.
• The --integration-id for export refers to a cloud storage integration configured in the Zilliz Cloud console (see import skill for setup guidance).
• Before deleting a backup, confirm with the user -- this is irreversible.
• When restoring, explain the difference between cluster restore (new cluster) and collection restore (into existing cluster).
• Suggest setting up a backup policy for production clusters.