Backups + Restore

End-to-end backup lifecycle with job and schedule control.

Athena supports S3-compatible backup and restore operations for registered PostgreSQL clients.

Core Endpoints

POST /admin/backups
GET /admin/backups
POST /admin/backups/{key}/restore
GET /admin/backups/{key}/download
DELETE /admin/backups/{key}

Job + Schedule Endpoints

GET /admin/backups/jobs
GET /admin/backups/jobs/{id}
POST /admin/backups/jobs/{id}/cancel
GET /admin/backups/schedules
POST /admin/backups/schedules
PATCH /admin/backups/schedules/{id}
DELETE /admin/backups/schedules/{id}

Example: Create Backup

curl -X POST "http://localhost:4052/admin/backups" \
  -H "content-type: application/json" \
  -H "x-athena-client: athena_logging" \
  -H "x-athena-admin-key: $ATHENA_ADMIN_KEY" \
  -d '{
    "client_name":"athena_logging",
    "bucket":"athena-backups",
    "prefix":"daily"
  }'

Required Runtime Dependencies

ATHENA_PG_DUMP_PATH / ATHENA_PG_RESTORE_PATH (or binaries on PATH)
S3-compatible endpoint and credentials
Reachable target database clients

Operational Notes

Treat backup/restore jobs as async workflows.
Monitor job status before invoking follow-up actions.
Apply retention policies through schedule configuration.

Cluster Operations

Health, metrics, and runbook-level Athena operations guidance.

Deployment

Deploying Athena with Docker Compose and systemd-friendly runtime settings.

On this page

Core Endpoints Job + Schedule Endpoints Example: Create Backup Required Runtime Dependencies Operational Notes