Dokploy

backup

POST/backup.create

backup-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

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"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/backup.create" \
  -d '{
  "schedule": "string",
  "enabled": true,
  "prefix": "string",
  "destinationId": "string",
  "database": "string",
  "mariadbId": "string",
  "mysqlId": "string",
  "postgresId": "string",
  "mongoId": "string",
  "databaseType": "postgres"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/backup.one

backup-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/backup.one?backupId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.update

backup-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

schedule
Required
string

enabledboolean | null

prefix
Required
string

Minimum length: 1

backupId
Required
string

destinationId
Required
string

database
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/backup.update" \
  -d '{
  "schedule": "string",
  "enabled": true,
  "prefix": "string",
  "backupId": "string",
  "destinationId": "string",
  "database": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.remove

backup-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/backup.remove" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.manualBackupPostgres

backup-manualBackupPostgres

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/backup.manualBackupPostgres" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.manualBackupMySql

backup-manualBackupMySql

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/backup.manualBackupMySql" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.manualBackupMariadb

backup-manualBackupMariadb

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/backup.manualBackupMariadb" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.manualBackupMongo

backup-manualBackupMongo

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/backup.manualBackupMongo" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

On this page