Skip to content

redisctl

Backup and Restore

redis-developer/redisctl

Backup and Restore¶

Manage database backups in Redis Cloud.

View Backup Settings¶

redisctl cloud database get 123456 789 -o json -q '{
  name: name,
  backup: backup
}'

Configure Automatic Backups¶

redisctl cloud database update 123456 789 --data '{
  "backup": {
    "enabled": true,
    "interval": 24,
    "destination": "s3://my-bucket/redis-backups"
  }
}' --wait

Backup Options¶

Field	Description
`enabled`	Enable/disable backups
`interval`	Hours between backups (12 or 24)
`destination`	S3 or GCS bucket URL

Manual Backup¶

Trigger an immediate backup:

redisctl cloud database backup 123456 789 --wait

List Backups¶

redisctl api cloud get /subscriptions/123456/databases/789/backups

Restore from Backup¶

To Same Database¶

redisctl cloud database restore 123456 789 \
  --backup-id <backup-id> \
  --wait

To New Database¶

Create new database
Import from backup location

redisctl cloud database create \
  --subscription-id 123456 \
  --name restored-db \
  --data '{
    "memoryLimitInGb": 1,
    "dataImport": {
      "sourceUri": "s3://bucket/backup.rdb"
    }
  }' \
  --wait

Backup to S3 Script¶

#!/bin/bash
SUB_ID="${1:?Usage: $0 <subscription-id> <database-id>}"
DB_ID="${2:?}"

echo "Triggering backup for database $DB_ID..."

# Configure backup destination if not set
redisctl cloud database update "$SUB_ID" "$DB_ID" --data '{
  "backup": {
    "enabled": true,
    "interval": 24,
    "destination": "s3://my-backup-bucket/redis"
  }
}' --wait

# Trigger immediate backup
redisctl cloud database backup "$SUB_ID" "$DB_ID" --wait

echo "Backup complete!"

Verify Backup Configuration¶

redisctl cloud database list --subscription-id 123456 -o json -q '[].{
  name: name,
  backup_enabled: backup.enabled,
  backup_interval: backup.interval
}'