Skip to content
SHC Docs

shc backup export

export a backup (or consistency group) to a local archive

shc backup export [backup-id] [flags]
--export-environment string filter --export-stack by environment (default "default")
--export-stack string export the latest backup for this stack
-f, --file string destination path for the exported archive
-h, --help help for export
-i, --id stringArray backup ID to export (repeatable)
--latest only export the latest backup (with --export-stack)
--with-connected include all backups sharing the target's consistency_id (requires --id)
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: $SHC_ENVIRONMENT)
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)