Coolify logoCoolify
Cloud

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}/imports

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

TypeScript Definitions

Use the request body type in TypeScript.

source*string
Value in"upload"
upload_id*string
Formatuuid
dump_all?boolean
Defaultfalse
replace_existing?boolean

Drop matching PostgreSQL objects before restoring a single-database archive.

Defaultfalse
keep_owners?boolean

Restore object owners and privileges from a single-database PostgreSQL archive. By default they are skipped, because the roles of another server usually do not exist.

Defaultfalse
restore_mysql_users?boolean

MySQL and MariaDB backups containing all databases: also restore the mysql system database (users, passwords, and privileges). By default the system databases are skipped, so the database keeps its own users and passwords.

Defaultfalse
sqlite_database?string

SQLite: the database file to restore into. Must be one of the database files. Defaults to the file named in the backup file name, else the first file.

source*string
Value in"s3"
s3_storage_uuid*string
path*string
dump_all?boolean
Defaultfalse
replace_existing?boolean

Drop matching PostgreSQL objects before restoring a single-database archive.

Defaultfalse
keep_owners?boolean

Restore object owners and privileges from a single-database PostgreSQL archive. By default they are skipped, because the roles of another server usually do not exist.

Defaultfalse
restore_mysql_users?boolean

MySQL and MariaDB backups containing all databases: also restore the mysql system database (users, passwords, and privileges). By default the system databases are skipped, so the database keeps its own users and passwords.

Defaultfalse
sqlite_database?string

SQLite: the database file to restore into. Must be one of the database files. Defaults to the file named in the backup file name, else the first file.

source*string
Value in"server"
path*string
dump_all?boolean
Defaultfalse
replace_existing?boolean

Drop matching PostgreSQL objects before restoring a single-database archive.

Defaultfalse
keep_owners?boolean

Restore object owners and privileges from a single-database PostgreSQL archive. By default they are skipped, because the roles of another server usually do not exist.

Defaultfalse
restore_mysql_users?boolean

MySQL and MariaDB backups containing all databases: also restore the mysql system database (users, passwords, and privileges). By default the system databases are skipped, so the database keeps its own users and passwords.

Defaultfalse
sqlite_database?string

SQLite: the database file to restore into. Must be one of the database files. Defaults to the file named in the backup file name, else the first file.

Response Body

application/json

curl -X POST "https://app.coolify.io/api/v1/databases/string/imports" \  -H "Content-Type: application/json" \  -d '{    "source": "upload",    "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb"  }'
Empty
Empty
{  "message": "Validation error.",  "errors": {    "name": [      "The name field is required."    ],    "api_url": [      "The api url field is required.",      "The api url format is invalid."    ]  }}

Create (DragonFly) POST

Create a new DragonFly database.

Create (KeyDB) POST

Create a new KeyDB database.