Skip to content
SHC Docs

shc backup verify

report what a backup ID holds, and refuse one that holds no data (for a file use backup inspect)

Report what this backup actually contains and whether it is still usable.

The default tier reads no data. It confirms the restic snapshot recorded for this backup is still present in its repository, that the manifest the snapshot carries is readable and names this backup, and it censuses what that manifest says the archive holds: how many of the deployment’s data subjects, at what size, against the total size backup ls shows.

It refuses an archive that carries no data. Measured on a live estate: a 208 KB keycloak archive stamped no_data_captured by its own capture (deployment metadata, not one realm) used to verify clean, with the same sentence a 579 MB archive got. An archive that accounts for no data subject is not a restore source and now fails, naming what it does hold.

--deep reads the bytes back. Everything above is read out of a document the capture wrote about itself. --deep streams the whole snapshot out of the repository (restic fetches, decrypts and hash-checks every pack this backup references) and reports the files and bytes that actually came back. It is per-snapshot, unlike restic check --read-data, which takes no snapshot argument and would read the entire repository.

What neither tier proves is that a restore of this archive onto a live stack succeeds; that needs a target. Every run prints what it proved and what it did not.

shc backup verify <backup-id|name> [flags]
--deep read every byte of the snapshot back out of the repository and report what came back
-h, --help help for verify
--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)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)