Backup

POST

/backup.create

Backup create

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`schedule`
Required
string

`enabled`boolean | null

`prefix`
Required
string

Minimum length: 1

`destinationId`
Required
string

`keepLatestCount`number | null

`database`
Required
string

Minimum length: 1

`mariadbId`string | null

`mysqlId`string | null

`postgresId`string | null

`mongoId`string | null

`databaseType`
Required
string

Value in: "postgres" | "mariadb" | "mysql" | "mongo" | "web-server"

`userId`string | null

`backupType`string

Value in: "database" | "compose"

`composeId`string | null

`serviceName`string | null

`metadata`null

curl -X POST "https://your-dokploy-instance.com/api/backup.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule": "string",
    "enabled": true,
    "prefix": "string",
    "destinationId": "string",
    "keepLatestCount": 0,
    "database": "string",
    "mariadbId": "string",
    "mysqlId": "string",
    "postgresId": "string",
    "mongoId": "string",
    "databaseType": "postgres",
    "userId": "string",
    "backupType": "database",
    "composeId": "string",
    "serviceName": "string",
    "metadata": null
  }'

Successful response

{}

GET

/backup.one

Backup one

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`backupId`
Required
string

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

Successful response

{}

POST

/backup.update

Backup update

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`schedule`
Required
string

`enabled`boolean | null

`prefix`
Required
string

Minimum length: 1

`backupId`
Required
string

`destinationId`
Required
string

`database`
Required
string

Minimum length: 1

`keepLatestCount`number | null

`serviceName`
Required
string | null

`metadata`null

`databaseType`
Required
string

Value in: "postgres" | "mariadb" | "mysql" | "mongo" | "web-server"

curl -X POST "https://your-dokploy-instance.com/api/backup.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule": "string",
    "enabled": true,
    "prefix": "string",
    "backupId": "string",
    "destinationId": "string",
    "database": "string",
    "keepLatestCount": 0,
    "serviceName": "string",
    "metadata": null,
    "databaseType": "postgres"
  }'

Successful response

{}

POST

/backup.remove

Backup remove

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`backupId`
Required
string

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

Successful response

{}

POST

/backup.manualBackupPostgres

Backup manual Backup Postgres

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`backupId`
Required
string

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

Successful response

{}

POST

/backup.manualBackupMySql

Backup manual Backup My Sql

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`backupId`
Required
string

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

Successful response

{}

POST

/backup.manualBackupMariadb

Backup manual Backup Mariadb

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`backupId`
Required
string

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

Successful response

{}

POST

/backup.manualBackupCompose

Backup manual Backup Compose

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`backupId`
Required
string

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

Successful response

{}

POST

/backup.manualBackupMongo

Backup manual Backup Mongo

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`backupId`
Required
string

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

Successful response

{}

POST

/backup.manualBackupWebServer

Backup manual Backup Web Server

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`backupId`
Required
string

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

Successful response

{}

GET

/backup.listBackupFiles

Backup list Backup Files

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`destinationId`
Required
string

`search`
Required
string

`serverId`string

curl -X GET "https://your-dokploy-instance.com/api/backup.listBackupFiles?destinationId=string&search=string&serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

Body

Authorization<token>

scheduleRequiredstring

enabledboolean | null

prefixRequiredstring

destinationIdRequiredstring

keepLatestCountnumber | null

databaseRequiredstring

mariadbIdstring | null

mysqlIdstring | null

postgresIdstring | null

mongoIdstring | null

databaseTypeRequiredstring

userIdstring | null

backupTypestring

composeIdstring | null

serviceNamestring | null

metadatanull

Response

TypeScript

Query

Authorization<token>

backupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

scheduleRequiredstring

enabledboolean | null

prefixRequiredstring

backupIdRequiredstring

destinationIdRequiredstring

databaseRequiredstring

keepLatestCountnumber | null

serviceNameRequiredstring | null

metadatanull

databaseTypeRequiredstring

Response

TypeScript

Body

Authorization<token>

backupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

backupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

backupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

backupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

backupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

backupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

backupIdRequiredstring

Response

TypeScript

Query

Authorization<token>

destinationIdRequiredstring

searchRequiredstring

serverIdstring

`Authorization`<token>

`schedule`
Required
string

`enabled`boolean | null

`prefix`
Required
string

`destinationId`
Required
string

`keepLatestCount`number | null

`database`
Required
string

`mariadbId`string | null

`mysqlId`string | null

`postgresId`string | null

`mongoId`string | null

`databaseType`
Required
string

`userId`string | null

`backupType`string

`composeId`string | null

`serviceName`string | null

`metadata`null

`Authorization`<token>

`backupId`
Required
string

`Authorization`<token>

`schedule`
Required
string

`enabled`boolean | null

`prefix`
Required
string

`backupId`
Required
string

`destinationId`
Required
string

`database`
Required
string

`keepLatestCount`number | null

`serviceName`
Required
string | null

`metadata`null

`databaseType`
Required
string

`Authorization`<token>

`backupId`
Required
string

`Authorization`<token>

`backupId`
Required
string

`Authorization`<token>

`backupId`
Required
string

`Authorization`<token>

`backupId`
Required
string

`Authorization`<token>

`backupId`
Required
string

`Authorization`<token>

`backupId`
Required
string

`Authorization`<token>

`backupId`
Required
string

`Authorization`<token>

`destinationId`
Required
string

`search`
Required
string

`serverId`string