Plans

A plan protects servers, volumes or one bucket of a project under a protection policy. The operator writes the policy. It sets the schedule, the retention and the repositories backups are written to. The vault on the backup repository sets the terms for manual backups. The plan names what is protected, how consistent each backup is and how it is encrypted. Every scheduled run takes one backup of each resource, and restores start from those backups.

📄️ List plans

Any reader of the project the token is scoped to.

📄️ Create a plan

Protects servers, volumes or a bucket under a protection policy. The policy sets the schedule, the retention and where backups are kept. The plan names what is protected and how consistent each backup is. A resource the service can protect only in part is refused with an account of what would and would not be covered.

📄️ Delete a plan

Stops the plan. Its backups stay restorable until they expire, unless `with_points` is set, which deletes them too. Only an operator can delete a plan under a mandatory policy. The answer is `202` with the deletion when the plan is kept for an operator to undelete, and always with `with_points`. Without `with_points`, a plan whose repository keeps deleted plans for no grace period, or whose policy no longer exists, is removed at once. The answer is then `204` with no body.

📄️ Show a plan

Any reader of the project the token is scoped to.

📄️ Change a plan

Renames a plan, pauses or resumes it, changes what it protects or moves it to another policy. A resource taken out of a plan is retired: its backups stop, and the ones it has stay restorable until they expire.

📄️ List a plan's missed backups

Scheduled backups that did not run, and why.

📄️ List what a plan could not protect

Every resource or disk the plan has been refused, why, and what to change.

📄️ Show a plan's measured protection

The recovery point each resource has actually achieved, the success rate, and the oldest backup that can still be restored.

📄️ Bring back a deleted plan

Brings back a deleted plan as it was, running or paused, with the backups that were deleted with it.

📄️ Offboard a project

Deletes every plan of a project that is leaving, with its backups. The answer gives the date the last of the project's data leaves storage, as `erased_by`.