Skip to Content

Backups

Backup policies, runs, targets and what a restore does.

Apps with volumes and stateful templates, such as databases, can be backed up. Backups are stored in your object storage and billed as storage usage. For the steps in the console, see Keep data with volumes and backups.

Policies

A backup policy sets:

  • a schedule (a cron expression),
  • how many days backups are kept,
  • the backup type: Full (a complete copy every run) or Incremental (only the changes, with a full copy every 7th run),
  • the compression.

Backups go to one or more targets; the primary target is used by default. An app can have several policies, for example nightly backups kept a week and monthly ones kept a year.

Volume backups are crash-consistent: they are taken while the app keeps running.

Runs

Each backup is a run, started by the schedule (scheduled) or by you (manual). A run is running, then succeeded or failed. Besides backups, a run can be a mirror, which copies the primary target's archive onto a secondary target.

Start a run with POST /v1/clusters/{cluster_id}/apps/{app_id}/backups and follow it at GET /v1/clusters/{cluster_id}/apps/{app_id}/backups/runs/{run_id}.

Deleting an app keeps its backups until their retention runs out.

Restores

AppRestore
PostgreSQLRestores into a new copy; you can pick a point in time between backups. The current database keeps running until you promote the restored copy.
ClickHouseRestores in place.
VolumesStops the app, replaces the data, then starts the app again.

A kept backup of a deleted app can be restored into a new app.

On this page