Dokploy

Volume Backups

Volume Backups list

GET
/volumeBackups.list

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

id*string
Length1 <= length
volumeBackupType*string
Value in"application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/volumeBackups.list?id=string&volumeBackupType=application"
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Volume Backups create

POST
/volumeBackups.create

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

name*string
volumeName*string
prefix*string
serviceType?string
Value in"application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"
appName?string
serviceName?string|null
turnOff?boolean
cronExpression*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*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/volumeBackups.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "volumeName": "string",    "prefix": "string",    "cronExpression": "string",    "destinationId": "string"  }'
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Volume Backups one

GET
/volumeBackups.one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

volumeBackupId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/volumeBackups.one?volumeBackupId=string"
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Volume Backups delete

POST
/volumeBackups.delete

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

volumeBackupId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/volumeBackups.delete" \  -H "Content-Type: application/json" \  -d '{    "volumeBackupId": "string"  }'
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Volume Backups update

POST
/volumeBackups.update

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

name*string
volumeName*string
prefix*string
serviceType?string
Value in"application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"
appName?string
serviceName?string|null
turnOff?boolean
cronExpression*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*string
volumeBackupId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/volumeBackups.update" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "volumeName": "string",    "prefix": "string",    "cronExpression": "string",    "destinationId": "string",    "volumeBackupId": "string"  }'
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Volume Backups run Manually

POST
/volumeBackups.runManually

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

volumeBackupId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/volumeBackups.runManually" \  -H "Content-Type: application/json" \  -d '{    "volumeBackupId": "string"  }'
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

User

Previous Page