Databases

Update

Changed on

Update a specific backup configuration for a given database, identified by its UUID and the backup ID

patch/databases/{uuid}/backups/{scheduled_backup_uuid}

Request

  • Base URL: https://app.coolify.io/api/v1
  • URL: https://app.coolify.io/api/v1/databases/{uuid}/backups/{scheduled_backup_uuid}
  • Auth: HTTP bearer

Path parameters

uuidstring required

UUID of the database.

scheduled_backup_uuidstring required

UUID of the backup configuration.

Request body

save_s3boolean

Whether data is saved in s3 or not

s3_storage_uuidstring

S3 storage UUID

backup_nowboolean

Whether to take a backup now or not

enabledboolean

Whether the backup is enabled or not

databases_to_backupstring

Comma separated list of databases to backup

dump_allboolean

Whether all databases are dumped or not

frequencystring

Frequency of the backup

database_backup_retention_amount_locallyinteger

Retention amount of the backup locally

database_backup_retention_days_locallyinteger

Retention days of the backup locally

database_backup_retention_max_storage_locallynumber

Max storage of the backup locally

database_backup_retention_amount_s3integer

Retention amount of the backup in s3

database_backup_retention_days_s3integer

Retention days of the backup in s3

database_backup_retention_max_storage_s3number

Max storage of the backup in S3

timeoutinteger

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

missing_backup_notification_daysinteger

Alert after this many days without an execution; 0 disables alerts

Response

Database backup configuration updated

Changes

  • b5f81ea5b5b5Revision changes
    • info

      added the new optional request property

  • a4892b2ef9afRevision changes
    • info

      the request property type was generalized from integer to number

    • info

      the request property type was generalized from integer to number