reference

Backup Configuration Reference

Backup Configuration

ServOS provides a built-in backup system for stateful services. Backup configuration is stored on each resource as backup_options and should be managed through the ServOS dashboard or resource API.

Configuring Backups via UI

  1. Navigate to your Service Details page.
  2. Go to the Backups tab (or look for the “Backup Settings” section).
  3. Click Configure Backups.
  4. Select your Backup Strategy:
    • Postgres: Dumps your database using pg_dump.
    • MySQL: Dumps your database using mysqldump.
    • Volume Snapshot: Backs up the entire persistent volume using Restic.
  5. Set your Schedule using a Cron expression (e.g., 0 0 * * * for daily at midnight).
  6. Set the Retention Policy (number of days to keep backups).
  7. Select a Storage Provider (S3 or MinIO).

API Reference

Backup policy updates are applied through /api/v1/resources/{id} by setting backup_options.

Get Configuration

GET /api/v1/resources/{id}

Response:

{
  "id": "uuid",
  "backup_options": {
    "strategy": "postgres",
    "frequency_cron": "0 0 * * *",
    "retention_days": 14,
    "enabled": true,
    "storage_provider_id": "uuid"
  }
}

Update Configuration

PUT /api/v1/resources/{id}

Request Body:

{
  "backup_options": {
    "strategy": "postgres",
    "frequency_cron": "0 0 * * *",
    "retention_days": 14,
    "enabled": true,
    "storage_provider_id": "uuid"
  }
}