ScalixScalix Docs
Sign up

Backups

Automatic backups, point-in-time recovery, and data export

Automatic Backups

ScalixNova backs up your database automatically. This gives you:

  • Automatic base backups plus WAL archiving, with no action required from you
  • Configurable retention (default: 7 days)
  • Encrypted backups with point-in-time recovery, stored within the EU region

Point-in-Time Recovery

Restore your database to any archived point within the retention window. WAL is archived on a five-minute bound while your database is active, and the open segment is also shipped when the database suspends — so the most recent restorable point is typically within five minutes of your latest write. A restore targeting a moment after the last archived point returns a 409 with guidance rather than silently restoring older data.

There are two distinct operations:

  • Restore to a timestamp — POST /api/v1/tenants/{tenant_id}/pitr/restore restores by timestamp, or to the latest recoverable point.
  • Branch at an LSN — POST /api/v1/tenants/{tenant_id}/timelines/{timeline_id}/branch with branch_lsn creates an isolated branch at a specific LSN (omit it to branch at the latest LSN).

Branching takes an LSN, not a timestamp — to recover to a wall-clock time, use the PITR restore endpoint.

Manual Export

Exports also work from the console, the REST API, or the SDKs; the direct PostgreSQL wire endpoint works with any pg_dump-compatible client.

Export your database:

bash
scalix-cloud export db --output ./backup/

This creates schema.sql and data.dump files in the output directory using pg_dump.

Full Project Export

Export all project data (database, KV store, storage):

bash
scalix-cloud export all --output scalix_export.tar.gz

This creates a tar.gz archive containing:

  • database/schema.sql — database schema
  • database/data.dump — database data
  • kv/pairs.json — all key-value pairs
  • storage/ — all storage objects

Off-site Backups

In addition to the continuous backup above, the platform takes nightly encrypted backups that are replicated off-site to EU-located storage. The restore procedure is documented and was verified when the backup system was set up; routine restore drills are being operationalized.

Retention Configuration

Backup retention is configured per tenant. Contact support or use the admin API to adjust retention periods beyond the default 7 days.