Dokploy

Backup

POST
/backup.create

Backup create

/backup.create

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

schedule
Required
string

enabledboolean | null

prefix
Required
string

Minimum length: 1

destinationId
Required
string

database
Required
string

Minimum length: 1

mariadbIdstring | null

mysqlIdstring | null

postgresIdstring | null

mongoIdstring | null

databaseType
Required
string

Value in: "postgres" | "mariadb" | "mysql" | "mongo"
curl -X POST "http://your-dokploy-instance.com/api/backup.create" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule": "string",
    "enabled": true,
    "prefix": "string",
    "destinationId": "string",
    "database": "string",
    "mariadbId": "string",
    "mysqlId": "string",
    "postgresId": "string",
    "mongoId": "string",
    "databaseType": "postgres"
  }'

Successful response

GET
/backup.one

Backup one

/backup.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

backupId
Required
string

curl -X GET "http://your-dokploy-instance.com/api/backup.one?backupId=string" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/backup.update

Backup update

/backup.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

schedule
Required
string

enabledboolean | null

prefix
Required
string

Minimum length: 1

backupId
Required
string

destinationId
Required
string

database
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/backup.update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule": "string",
    "enabled": true,
    "prefix": "string",
    "backupId": "string",
    "destinationId": "string",
    "database": "string"
  }'

Successful response

POST
/backup.remove

Backup remove

/backup.remove

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

backupId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/backup.remove" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "backupId": "string"
  }'

Successful response

POST
/backup.manualBackupPostgres

Backup manual Backup Postgres

/backup.manualBackupPostgres

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

backupId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/backup.manualBackupPostgres" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "backupId": "string"
  }'

Successful response

POST
/backup.manualBackupMySql

Backup manual Backup My Sql

/backup.manualBackupMySql

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

backupId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/backup.manualBackupMySql" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "backupId": "string"
  }'

Successful response

POST
/backup.manualBackupMariadb

Backup manual Backup Mariadb

/backup.manualBackupMariadb

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

backupId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/backup.manualBackupMariadb" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "backupId": "string"
  }'

Successful response

POST
/backup.manualBackupMongo

Backup manual Backup Mongo

/backup.manualBackupMongo

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

backupId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/backup.manualBackupMongo" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "backupId": "string"
  }'

Successful response