Coolify logoCoolify
Cloud

Create 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.

POST
/databases/{uuid}/backups

Create a new scheduled backup configuration for a database

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.

Request Body

application/json

Backup configuration data

TypeScript Definitions

Use the request body type in TypeScript.

frequency*string

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

enabled?boolean

Whether the backup is enabled

Defaulttrue
save_s3?boolean

Whether to save backups to S3

Defaultfalse
disable_local_backup?boolean

Delete the local backup file after the upload to S3. Only allowed when save_s3 is true.

Defaultfalse
s3_storage_uuid?string

Primary S3 storage UUID. Sent without s3_storage_uuids, it selects this storage as the only destination. Either field is required if save_s3 is true.

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.

databases_to_backup?string

Comma separated list of databases to backup

dump_all?boolean

Whether to dump all databases

Defaultfalse
backup_now?boolean

Whether to trigger backup immediately after creation. Needs a token with the deploy permission.

database_backup_retention_amount_locally?integer

Number of backups to retain locally

database_backup_retention_days_locally?integer

Number of days to retain backups locally

database_backup_retention_max_storage_locally?number

Max storage (GB) for local backups

database_backup_retention_amount_s3?integer

Number of backups to retain in S3

database_backup_retention_days_s3?integer

Number of days to retain backups in S3

database_backup_retention_max_storage_s3?number

Max storage (GB) for S3 backups

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

Default0
Range0 <= value <= 365

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.coolify.io/api/v1/databases/string/backups" \  -H "Content-Type: application/json" \  -d '{    "frequency": "string"  }'
{  "uuid": "550e8400-e29b-41d4-a716-446655440000",  "message": "Backup configuration created successfully."}
{  "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."    ]  }}

Clone POST

Clone a database to a destination owned by the authenticated team.

Create (Clickhouse) POST

Create a new Clickhouse database.