Backups

A backup is one resource's data at one instant: a server's disks, a volume, or a bucket's objects. A repository, registered by an operator, holds the data. A vault offers that repository to projects. A policy sets the schedule and the retention. A plan applies a policy to the project's resources and takes a backup of each one on schedule. A manual backup can be taken at any time, of a plan's resources or of one server or volume straight into a vault. Restores, attachments and file browsing all start from a backup.

📄️ List backups

Backups in state `deleted` are left out unless `state` asks for them.

📄️ Back up now

Takes a backup outside the schedule. Name `plan_id` to run a plan, for every resource it protects or for those in `resource_ids`. Name `resource_kind`, `resource_id` and `vault_id` to back up one server or volume into a vault. The backup is kept until `keep_until`, or until deleted with `until_deleted` where the vault offers it, within the vault's terms.

📄️ Delete a backup

When the repository keeps deleted backups for a while, or the backup is still locked, the backup is hidden at once, not erased; it is purged no earlier than `purge_after`, and an operator can bring it back until then. A lock never refuses this delete, only when the backup actually leaves. Otherwise it is erased now, and `job_id` names the job erasing it. A backup under a legal hold cannot be deleted.

📄️ Show a backup

Any reader of the project the token is scoped to.

📄️ Read a backup's record from storage

The backup's self-describing record, read from the repository rather than from this cloud's database. It answers for a backup this cloud has never seen.

📄️ Show a backup's metrics

Sizes, ratios and how long each phase took. A figure that cannot be measured is left out and explained under `unavailable`. Figures that depend on other projects' data are shown to operators only.

📄️ Bring back a deleted backup

Lifts a delete before the backup is erased.

📄️ Verify a backup now

Re-reads and checks all of the backup's data instead of waiting for the regular verification. The backup's state changes only when the check finishes. The answer is the job doing it.