Skip to main content

Organization Backup

Back up and restore your organization's own configuration — its projects, services, environments, domains, connections and settings — to your own S3 bucket. It's self-serve: you run it, it only ever touches your organization, and a restore is safe by design because it can't affect anyone else on the platform.

Everything here lives under Settings → Organization backup.

What this does and doesn't cover

An organization backup captures your control-plane configuration — the definitions of your projects, apps, databases, domains, registries, git connections, SSH keys and schedules. It does not copy the data inside your databases; for that, use the per-service database backups on each database (Postgres/MySQL/MariaDB/Mongo), which you can also send to an S3 destination.

Scope: your organization only

A backup and restore are limited to the organization you're currently in. Restoring one overwrites your organization's current configuration with the snapshot — it never reads or changes any other organization.

Prerequisites​

  • You must be an organization owner or admin.
  • At least one S3 destination (a bucket to store backups in) under Settings → S3 Destinations. Any S3-compatible provider works; create the bucket and an access key with write permission on it, then add it there. Step-by-step: Configure an AWS S3 bucket.

Back up​

  1. Go to Settings → Organization backup.
  2. Pick a Destination.
  3. Click Create backup.

Each backup is a single file in your bucket, under org-backups/<your-organization-id>/. It appears in the Backups list on the page, newest information first.

Restore​

Restoring re-applies a backup's configuration to your current organization, overwriting what's there now. Use it to roll back after a bad change, or to recover your setup.

  1. In the Backups list, click Restore on the snapshot you want.
  2. Type restore to confirm.
  3. Watch the log until "Restore completed".
Restore overwrites current configuration

A restore brings your projects and services back to how they were in the snapshot. Anything you changed since then is replaced by the snapshot's version. It's scoped to your organization, so it can't affect other organizations — but within yours, treat it as a rollback.