Volume Backups

GET

/volumeBackups.list

Volume Backups list

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`id`
Required
string

Minimum length: 1

`volumeBackupType`
Required
string

curl -X GET "https://your-dokploy-instance.com/api/volumeBackups.list?id=string&volumeBackupType=application" \
  -H "Authorization: <token>"

Successful response

{}

POST

/volumeBackups.create

Volume Backups create

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`name`
Required
string

`volumeName`
Required
string

`prefix`
Required
string

`serviceType`string

`appName`string

`serviceName`string | null

`turnOff`boolean

`cronExpression`
Required
string

`keepLatestCount`number | null

`enabled`boolean | null

`applicationId`string | null

`postgresId`string | null

`mariadbId`string | null

`mongoId`string | null

`mysqlId`string | null

`redisId`string | null

`composeId`string | null

`createdAt`string

`destinationId`
Required
string

curl -X POST "https://your-dokploy-instance.com/api/volumeBackups.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "volumeName": "string",
    "prefix": "string",
    "serviceType": "application",
    "appName": "string",
    "serviceName": "string",
    "turnOff": true,
    "cronExpression": "string",
    "keepLatestCount": 0,
    "enabled": true,
    "applicationId": "string",
    "postgresId": "string",
    "mariadbId": "string",
    "mongoId": "string",
    "mysqlId": "string",
    "redisId": "string",
    "composeId": "string",
    "createdAt": "string",
    "destinationId": "string"
  }'

Successful response

{}

GET

/volumeBackups.one

Volume Backups one

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`volumeBackupId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/volumeBackups.delete

Volume Backups delete

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`volumeBackupId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/volumeBackups.update

Volume Backups update

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`name`
Required
string

`volumeName`
Required
string

`prefix`
Required
string

`serviceType`string

`appName`string

`serviceName`string | null

`turnOff`boolean

`cronExpression`
Required
string

`keepLatestCount`number | null

`enabled`boolean | null

`applicationId`string | null

`postgresId`string | null

`mariadbId`string | null

`mongoId`string | null

`mysqlId`string | null

`redisId`string | null

`composeId`string | null

`createdAt`string

`destinationId`
Required
string

`volumeBackupId`
Required
string

Minimum length: 1

curl -X POST "https://your-dokploy-instance.com/api/volumeBackups.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "volumeName": "string",
    "prefix": "string",
    "serviceType": "application",
    "appName": "string",
    "serviceName": "string",
    "turnOff": true,
    "cronExpression": "string",
    "keepLatestCount": 0,
    "enabled": true,
    "applicationId": "string",
    "postgresId": "string",
    "mariadbId": "string",
    "mongoId": "string",
    "mysqlId": "string",
    "redisId": "string",
    "composeId": "string",
    "createdAt": "string",
    "destinationId": "string",
    "volumeBackupId": "string"
  }'

Successful response

{}

POST

/volumeBackups.runManually

Volume Backups run Manually

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`volumeBackupId`
Required
string

Minimum length: 1

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

Successful response

{}

Query

Authorization<token>

idRequiredstring

volumeBackupTypeRequiredstring

Response

TypeScript

Body

Authorization<token>

nameRequiredstring

volumeNameRequiredstring

prefixRequiredstring

serviceTypestring

appNamestring

serviceNamestring | null

turnOffboolean

cronExpressionRequiredstring

keepLatestCountnumber | null

enabledboolean | null

applicationIdstring | null

postgresIdstring | null

mariadbIdstring | null

mongoIdstring | null

mysqlIdstring | null

redisIdstring | null

composeIdstring | null

createdAtstring

destinationIdRequiredstring

Response

TypeScript

Query

Authorization<token>

volumeBackupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

volumeBackupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

nameRequiredstring

volumeNameRequiredstring

prefixRequiredstring

serviceTypestring

appNamestring

serviceNamestring | null

turnOffboolean

cronExpressionRequiredstring

keepLatestCountnumber | null

enabledboolean | null

applicationIdstring | null

postgresIdstring | null

mariadbIdstring | null

mongoIdstring | null

mysqlIdstring | null

redisIdstring | null

composeIdstring | null

createdAtstring

destinationIdRequiredstring

volumeBackupIdRequiredstring

Response

TypeScript

Body

Authorization<token>

volumeBackupIdRequiredstring

Response

TypeScript

`Authorization`<token>

`id`
Required
string

`volumeBackupType`
Required
string

`Authorization`<token>

`name`
Required
string

`volumeName`
Required
string

`prefix`
Required
string

`serviceType`string

`appName`string

`serviceName`string | null

`turnOff`boolean

`cronExpression`
Required
string

`keepLatestCount`number | null

`enabled`boolean | null

`applicationId`string | null

`postgresId`string | null

`mariadbId`string | null

`mongoId`string | null

`mysqlId`string | null

`redisId`string | null

`composeId`string | null

`createdAt`string

`destinationId`
Required
string

`Authorization`<token>

`volumeBackupId`
Required
string

`Authorization`<token>

`volumeBackupId`
Required
string

`Authorization`<token>

`name`
Required
string

`volumeName`
Required
string

`prefix`
Required
string

`serviceType`string

`appName`string

`serviceName`string | null

`turnOff`boolean

`cronExpression`
Required
string

`keepLatestCount`number | null

`enabled`boolean | null

`applicationId`string | null

`postgresId`string | null

`mariadbId`string | null

`mongoId`string | null

`mysqlId`string | null

`redisId`string | null

`composeId`string | null

`createdAt`string

`destinationId`
Required
string

`volumeBackupId`
Required
string

`Authorization`<token>

`volumeBackupId`
Required
string