Skip to content

Backup & Restore

Enterprise

This feature requires an Enterprise license.

Backup & Restore provides database backup and recovery capabilities directly from the Ops Atlas UI. Each backup is tracked as a BackupRecord entity with metadata including timestamp, size, and status.

Configuration

Backup storage is configured via an environment variable on the backend service:

VariableDefaultDescription
BACKUP_DIRECTORY/app/backupsDirectory where backup files are stored

In the default Docker Compose setup, this directory is mapped to the backups_data volume to ensure backups persist across container restarts:

yaml
backend:
  environment:
    BACKUP_DIRECTORY: /app/backups
  volumes:
    - backups_data:/app/backups

volumes:
  backups_data:

WARNING

Ensure the backups_data volume is included in your infrastructure backup strategy. Backups stored only inside the volume are lost if the volume is deleted.

Usage

Creating a Backup

  1. Navigate to Backups (/backups) from the sidebar.
  2. Click Create Backup.
  3. The backup runs against the connected PostgreSQL database and a new record appears in the backup history table.
  4. Once complete, the status changes to Completed and the file size is displayed.

Restoring from a Backup

  1. In the backup history table, locate the backup you want to restore.
  2. Click the Restore action on that row.
  3. Confirm the restore operation in the dialog.
  4. The database is restored to the state captured in that backup.

DANGER

Restoring a backup replaces the current database contents. This operation cannot be undone. Make sure you create a fresh backup before restoring an older one.

Backup History

The backup history table displays all recorded backups with:

  • Timestamp of when the backup was created
  • File size
  • Status (In Progress, Completed, Failed)
  • Actions (Download, Restore, Delete)

API Endpoints

MethodEndpointDescription
POST/api/backupsCreate a new backup
GET/api/backupsList all backup records
POST/api/backups/:id/restoreRestore from a specific backup
DELETE/api/backups/:idDelete a backup record and file

Frontend Route

RouteDescription
/backupsBackup management and history viewer

Released under the MIT License.