Sign in

v1

latestOpenAPI 3.1.02026-07-1213613295.5 KB
Databases

Create Backup

Create a new scheduled backup configuration for a database

post/databases/{uuid}/backups

Path parameters

uuidstring required

UUID of the database.

Request body

frequencystring required

Backup frequency (cron expression or: every_minute, hourly, daily, weekly, monthly, yearly)

enabledboolean

Whether the backup is enabled

save_s3boolean

Whether to save backups to S3

s3_storage_uuidstring

S3 storage UUID (required if save_s3 is true)

databases_to_backupstring

Comma separated list of databases to backup

dump_allboolean

Whether to dump all databases

backup_nowboolean

Whether to trigger backup immediately after creation

database_backup_retention_amount_locallyinteger

Number of backups to retain locally

database_backup_retention_days_locallyinteger

Number of days to retain backups locally

database_backup_retention_max_storage_locallynumber

Max storage (GB) for local backups

database_backup_retention_amount_s3integer

Number of backups to retain in S3

database_backup_retention_days_s3integer

Number of days to retain backups in S3

database_backup_retention_max_storage_s3number

Max storage (GB) for S3 backups

timeoutinteger

Backup job timeout in seconds (min: 60, max: 36000)

Response

Backup configuration created successfully

uuidstring uuid
messagestring

Example response

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Backup configuration created successfully."
}