openapi: 3.1.0 info: title: Dokploy admin volumeBackups API description: Complete API documentation for Dokploy - Deploy applications, manage databases, and orchestrate your infrastructure. This API allows you to programmatically manage all aspects of your Dokploy instance. 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 servers: - url: https://your-dokploy-instance.com/api security: - apiKey: [] tags: - name: volumeBackups paths: /volumeBackups.list: get: operationId: volumeBackups-list tags: - volumeBackups security: - Authorization: [] 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' /volumeBackups.create: post: operationId: volumeBackups-create tags: - volumeBackups security: - Authorization: [] parameters: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string volumeName: type: string 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' /volumeBackups.one: get: operationId: volumeBackups-one tags: - volumeBackups security: - Authorization: [] 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' /volumeBackups.delete: post: operationId: volumeBackups-delete tags: - volumeBackups security: - Authorization: [] 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' /volumeBackups.update: post: operationId: volumeBackups-update tags: - volumeBackups security: - Authorization: [] parameters: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string volumeName: type: string 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' /volumeBackups.runManually: post: operationId: volumeBackups-runManually tags: - volumeBackups security: - Authorization: [] 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' components: schemas: 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.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.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: [] 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: [] 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. externalDocs: description: Full documentation url: https://docs.dokploy.com