Coolify logoCoolify
Cloud

Database backup

API server

https://app.coolify.io/api/v1

Choose where to send API requests

This changes the request URL and code examples on every endpoint page.

API server type

Requests will use

https://app.coolify.io/api/v1

Use only a Coolify URL you trust. Sending a test request also sends the API token you enter.

PATCH
/databases/{uuid}/backups/{scheduled_backup_uuid}

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

Authorization

bearerAuth
AuthorizationBearer <token>

Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.

In: header

Path Parameters

uuid*string

UUID of the database.

scheduled_backup_uuid*string

UUID of the backup configuration.

Request Body

application/json

Database backup configuration data

TypeScript Definitions

Use the request body type in TypeScript.

save_s3?boolean

Whether data is saved in s3 or not

disable_local_backup?boolean

Delete the local backup file after the upload to S3. Only allowed when save_s3 is true. Turning save_s3 off also turns this off.

s3_storage_uuid?string

Primary S3 storage UUID. Sent without s3_storage_uuids, it selects this storage as the only destination; when it is already a destination, it becomes the primary destination and the other destinations stay.

s3_storage_uuids?array<string>

UUIDs of every S3 storage the backup is uploaded to. Replaces the current destinations. When s3_storage_uuid is also sent, it must be in this list and becomes the primary destination; otherwise the first entry is the primary destination.

backup_now?boolean

Whether to take a backup now or not. Needs a token with the deploy permission.

enabled?boolean

Whether the backup is enabled or not

databases_to_backup?string

Comma separated list of databases to backup

dump_all?boolean

Whether all databases are dumped or not

frequency?string

Frequency of the backup

database_backup_retention_amount_locally?integer

Retention amount of the backup locally

database_backup_retention_days_locally?integer

Retention days of the backup locally

database_backup_retention_max_storage_locally?number

Max storage of the backup locally

database_backup_retention_amount_s3?integer

Retention amount of the backup in s3

database_backup_retention_days_s3?integer

Retention days of the backup in s3

database_backup_retention_max_storage_s3?number

Max storage of the backup in S3

timeout?integer

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

Default3600
missing_backup_notification_days?integer

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

Range0 <= value <= 365

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.coolify.io/api/v1/databases/string/backups/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "Invalid token."}
{  "message": "Unauthenticated."}
Empty
{  "message": "Resource not found."}
{  "message": "Validation error.",  "errors": {    "name": [      "The name field is required."    ],    "api_url": [      "The api url field is required.",      "The api url format is invalid."    ]  }}

Stop POST

Stop database.

Database PATCH

Update database by UUID.