Dokploy Volume Backups API
The volumeBackups API from Dokploy — 6 operation(s) for volumebackups.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/dokploy:dokploy-volumebackups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Dokploy Volume Backups API
version: 1.0.0
contact:
name: Dokploy Team
url: https://dokploy.com
license:
name: Apache 2.0
url: https://github.com/dokploy/dokploy/blob/canary/LICENSE
description: 'Operations tagged volumeBackups across 2 of this provider''s published API definitions: dokploy-openapi.json, dokploy-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://your-dokploy-instance.com/api
tags:
- name: volumeBackups
paths:
/volumeBackups.list:
get:
operationId: volumeBackups-list
tags:
- volumeBackups
security:
- x-api-key: []
parameters:
- in: query
name: id
schema:
type: string
minLength: 1
required: true
- in: query
name: volumeBackupType
schema:
type: string
enum:
- application
- postgres
- mysql
- mariadb
- mongo
- redis
- compose
- libsql
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'400':
description: Invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/error.BAD_REQUEST'
'401':
description: Authorization not provided
content:
application/json:
schema:
$ref: '#/components/schemas/error.UNAUTHORIZED'
'403':
description: Insufficient access
content:
application/json:
schema:
$ref: '#/components/schemas/error.FORBIDDEN'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/error.NOT_FOUND'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
summary: Volume backups list
x-summary-source: derived
servers:
- url: https://your-dokploy-instance.com/api
/volumeBackups.create:
post:
operationId: volumeBackups-create
tags:
- volumeBackups
security:
- x-api-key: []
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
volumeName:
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
prefix:
type: string
serviceType:
type: string
enum:
- application
- postgres
- mysql
- mariadb
- mongo
- redis
- compose
- libsql
appName:
type: string
serviceName:
anyOf:
- type: string
- type: 'null'
turnOff:
type: boolean
cronExpression:
type: string
keepLatestCount:
anyOf:
- type: number
- type: 'null'
enabled:
anyOf:
- type: boolean
- type: 'null'
applicationId:
anyOf:
- type: string
- type: 'null'
postgresId:
anyOf:
- type: string
- type: 'null'
mariadbId:
anyOf:
- type: string
- type: 'null'
mongoId:
anyOf:
- type: string
- type: 'null'
mysqlId:
anyOf:
- type: string
- type: 'null'
redisId:
anyOf:
- type: string
- type: 'null'
libsqlId:
anyOf:
- type: string
- type: 'null'
composeId:
anyOf:
- type: string
- type: 'null'
createdAt:
type: string
destinationId:
type: string
required:
- name
- volumeName
- prefix
- cronExpression
- destinationId
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'400':
description: Invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/error.BAD_REQUEST'
'401':
description: Authorization not provided
content:
application/json:
schema:
$ref: '#/components/schemas/error.UNAUTHORIZED'
'403':
description: Insufficient access
content:
application/json:
schema:
$ref: '#/components/schemas/error.FORBIDDEN'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
summary: Volume backups create
x-summary-source: derived
servers:
- url: https://your-dokploy-instance.com/api
/volumeBackups.one:
get:
operationId: volumeBackups-one
tags:
- volumeBackups
security:
- x-api-key: []
parameters:
- in: query
name: volumeBackupId
schema:
type: string
minLength: 1
required: true
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'400':
description: Invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/error.BAD_REQUEST'
'401':
description: Authorization not provided
content:
application/json:
schema:
$ref: '#/components/schemas/error.UNAUTHORIZED'
'403':
description: Insufficient access
content:
application/json:
schema:
$ref: '#/components/schemas/error.FORBIDDEN'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/error.NOT_FOUND'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
summary: Volume backups one
x-summary-source: derived
servers:
- url: https://your-dokploy-instance.com/api
/volumeBackups.delete:
post:
operationId: volumeBackups-delete
tags:
- volumeBackups
security:
- x-api-key: []
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
volumeBackupId:
type: string
minLength: 1
required:
- volumeBackupId
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'400':
description: Invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/error.BAD_REQUEST'
'401':
description: Authorization not provided
content:
application/json:
schema:
$ref: '#/components/schemas/error.UNAUTHORIZED'
'403':
description: Insufficient access
content:
application/json:
schema:
$ref: '#/components/schemas/error.FORBIDDEN'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
summary: Volume backups delete
x-summary-source: derived
servers:
- url: https://your-dokploy-instance.com/api
/volumeBackups.update:
post:
operationId: volumeBackups-update
tags:
- volumeBackups
security:
- x-api-key: []
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
volumeName:
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
prefix:
type: string
serviceType:
type: string
enum:
- application
- postgres
- mysql
- mariadb
- mongo
- redis
- compose
- libsql
appName:
type: string
serviceName:
anyOf:
- type: string
- type: 'null'
turnOff:
type: boolean
cronExpression:
type: string
keepLatestCount:
anyOf:
- type: number
- type: 'null'
enabled:
anyOf:
- type: boolean
- type: 'null'
applicationId:
anyOf:
- type: string
- type: 'null'
postgresId:
anyOf:
- type: string
- type: 'null'
mariadbId:
anyOf:
- type: string
- type: 'null'
mongoId:
anyOf:
- type: string
- type: 'null'
mysqlId:
anyOf:
- type: string
- type: 'null'
redisId:
anyOf:
- type: string
- type: 'null'
libsqlId:
anyOf:
- type: string
- type: 'null'
composeId:
anyOf:
- type: string
- type: 'null'
createdAt:
type: string
destinationId:
type: string
volumeBackupId:
type: string
minLength: 1
required:
- name
- volumeName
- prefix
- cronExpression
- destinationId
- volumeBackupId
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'400':
description: Invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/error.BAD_REQUEST'
'401':
description: Authorization not provided
content:
application/json:
schema:
$ref: '#/components/schemas/error.UNAUTHORIZED'
'403':
description: Insufficient access
content:
application/json:
schema:
$ref: '#/components/schemas/error.FORBIDDEN'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
summary: Volume backups update
x-summary-source: derived
servers:
- url: https://your-dokploy-instance.com/api
/volumeBackups.runManually:
post:
operationId: volumeBackups-runManually
tags:
- volumeBackups
security:
- x-api-key: []
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
volumeBackupId:
type: string
minLength: 1
required:
- volumeBackupId
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'400':
description: Invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/error.BAD_REQUEST'
'401':
description: Authorization not provided
content:
application/json:
schema:
$ref: '#/components/schemas/error.UNAUTHORIZED'
'403':
description: Insufficient access
content:
application/json:
schema:
$ref: '#/components/schemas/error.FORBIDDEN'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
summary: Volume backups run manually
x-summary-source: derived
servers:
- url: https://your-dokploy-instance.com/api
components:
schemas:
error.FORBIDDEN:
type: object
properties:
message:
type: string
description: The error message
example: Insufficient access
code:
type: string
description: The error code
example: FORBIDDEN
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Insufficient access error (403)
description: The error information
example:
code: FORBIDDEN
message: Insufficient access
issues: []
error.INTERNAL_SERVER_ERROR:
type: object
properties:
message:
type: string
description: The error message
example: Internal server error
code:
type: string
description: The error code
example: INTERNAL_SERVER_ERROR
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Internal server error error (500)
description: The error information
example:
code: INTERNAL_SERVER_ERROR
message: Internal server error
issues: []
error.BAD_REQUEST:
type: object
properties:
message:
type: string
description: The error message
example: Invalid input data
code:
type: string
description: The error code
example: BAD_REQUEST
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Invalid input data error (400)
description: The error information
example:
code: BAD_REQUEST
message: Invalid input data
issues: []
error.NOT_FOUND:
type: object
properties:
message:
type: string
description: The error message
example: Not found
code:
type: string
description: The error code
example: NOT_FOUND
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Not found error (404)
description: The error information
example:
code: NOT_FOUND
message: Not found
issues: []
error.UNAUTHORIZED:
type: object
properties:
message:
type: string
description: The error message
example: Authorization not provided
code:
type: string
description: The error code
example: UNAUTHORIZED
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Authorization not provided error (401)
description: The error information
example:
code: UNAUTHORIZED
message: Authorization not provided
issues: []
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API key authentication. Generate an API key from your Dokploy dashboard under Settings > API Keys.
x-api-key:
type: apiKey
in: header
name: x-api-key
description: API key authentication. Use YOUR-GENERATED-API-KEY
x-default: your-key
externalDocs:
description: Full documentation
url: https://docs.dokploy.com
x-refined-from:
- dokploy-openapi.json
- dokploy-openapi.yml