Databases

Set database storage backup schedule

Changed on

Create or replace the backup schedule for a database persistent volume or directory storage.

put/databases/{uuid}/storages/{storage_uuid}/backups

Request

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

Path parameters

uuidstring required

UUID of the database.

storage_uuidstring required

UUID of the persistent volume or directory storage.

Request body

frequencystring required
enabledboolean
save_s3boolean
disable_local_backupboolean
stop_during_backupboolean
s3_storage_uuidstring nullable
retention_amount_locallyinteger
retention_days_locallyinteger
retention_max_storage_locallynumber float
retention_amount_s3integer
retention_days_s3integer
retention_max_storage_s3number float
timeoutinteger
missing_backup_notification_daysinteger

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

Example request

{
  "frequency": "0 2 * * *"
}

Response

Backup schedule replaced.

uuidstring required
messagestring required
storage_uuidstring required
storage_type'persistent' | 'directory' required
frequencystring required
enabledboolean required
save_s3boolean required
disable_local_backupboolean required
stop_during_backupboolean required
s3_storage_uuidstring nullable
retention_amount_locallyinteger required
retention_days_locallyinteger required
retention_max_storage_locallynumber float required
retention_amount_s3integer required
retention_days_s3integer required
retention_max_storage_s3number float required
timeoutinteger required
missing_backup_notification_daysinteger required

Changes

  • c2e3e90e8469Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • b5f81ea5b5b5Revision changes
    • info

      the request property default value changed from 3600 to 36000