Workspace backups and restore

Workspace backups, called tenant backups in the backend, preserve a workspace-wide restore point. They complement Git-managed backend source and entity-level snapshots; they do not replace either one.

Use your workspace code for the CLI's --tenant option. These are the same context, not separate backup targets. See workspaces and tenants.

Browse restore points

List backup records for the selected tenant before creating or restoring one:

pnpm exec gsb --tenant production backup list
pnpm exec gsb --tenant production backup list --status completed --json
pnpm exec gsb --tenant production backup show <backup-id-or-code>

Each record exposes its status, code, creation date, and whether it was created automatically or manually. Automatic backup availability and retention depend on the workspace plan. An authorized operator can create an on-demand backup where the plan and tenant policy allow it.

Create an on-demand backup

pnpm exec gsb --tenant production backup add \
  --title "Before September release"

The command creates the backup record and starts the tenant backup. Track it until the record reaches Completed; starting the operation does not prove the snapshot finished.

Restore a completed backup

pnpm exec gsb --tenant production backup restore <backup-id-or-code>

Restore is destructive and requires typing the target tenant code unless --yes is supplied. The platform takes a backup of the current tenant state before replacing it with the selected completed backup. After the restore starts, monitor backup status and verify the application, definitions, data, functions, and workflows before reopening normal writes.

Choose the right recovery layer

Layer	Use it for
Git source	Review backend resources and redeploy a previous source state
Entity snapshot	Restore one version-enabled entity before or after a focused change
Tenant backup	Recover a workspace-wide restore point after a broad release or incident
Resource pack	Rebuild, archive, or share selected infrastructure and approved data between workspaces

A Git revert does not restore runtime data by itself. Check out or revert the reviewed commit, preview the backend changes, and deploy it as a new forward release. Use an entity snapshot or tenant backup when data also needs recovery. Resource packs are portable selected artifacts, not continuous replication or a substitute for retained tenant backups.

Before relying on a restore point, run the backup and recovery acceptance check. Verify attachments, the supported isolated-test restore procedure, and measured RTO/RPO; a completed backup record alone proves none of those outcomes.

See Backend source control with Git, Entity versioning, and CI/CD, deployment, and seeds for the related controls.