Skip to content
SHC Docs

shc backup ls

list backups

List the backups owned by the active tenant. Use --stack to scope to one stack, --all-tenants for the estate-wide view.

SIZE_BYTES is what a backup stores: the .bak on disk, or a restic snapshot’s data in the repository. APPARENT_BYTES, where a backup recorded it, is what its files add up to at full length, holes included.

shc backup ls [flags]
--all-tenants list every tenant's backups (platform admins; others see their own tenant)
-h, --help help for ls
--limit int maximum rows to return (0 = all)
--offset int row offset
-s, --stack string filter by stack name
--status string filter by status
--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: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--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)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)