Dokploy · Capability

Dokploy API — backup

Dokploy API — backup. 12 operations. Lead operation: backup.create. Self-contained Naftiko capability covering one Dokploy business surface.

Dokploy API — backup is a Naftiko capability published by Dokploy, one of 48 capabilities the APIs.io network indexes for this provider. It bundles 12 operations across the POST and GET methods.

The capability includes 2 read-only operations and 10 state-changing operations. Lead operation: backup-create. Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Tagged areas include Dokploy and backup.

Run with Naftiko Dokploybackup

What You Can Do

POST
Backup create — backup-create
/v1/backup.create
GET
Backup one — backup-one
/v1/backup.one
POST
Backup update — backup-update
/v1/backup.update
POST
Backup remove — backup-remove
/v1/backup.remove
POST
Backup manualbackuppostgres — backup-manualBackupPostgres
/v1/backup.manualBackupPostgres
POST
Backup manualbackupmysql — backup-manualBackupMySql
/v1/backup.manualBackupMySql
POST
Backup manualbackupmariadb — backup-manualBackupMariadb
/v1/backup.manualBackupMariadb
POST
Backup manualbackupcompose — backup-manualBackupCompose
/v1/backup.manualBackupCompose
POST
Backup manualbackupmongo — backup-manualBackupMongo
/v1/backup.manualBackupMongo
POST
Backup manualbackuplibsql — backup-manualBackupLibsql
/v1/backup.manualBackupLibsql
POST
Backup manualbackupwebserver — backup-manualBackupWebServer
/v1/backup.manualBackupWebServer
GET
Backup listbackupfiles — backup-listBackupFiles
/v1/backup.listBackupFiles

MCP Tools

backup-create

backup-create

backup-one

backup-one

read-only idempotent
backup-update

backup-update

backup-remove

backup-remove

backup-manualBackupPostgres

backup-manualBackupPostgres

backup-manualBackupMySql

backup-manualBackupMySql

backup-manualBackupMariadb

backup-manualBackupMariadb

backup-manualBackupCompose

backup-manualBackupCompose

backup-manualBackupMongo

backup-manualBackupMongo

backup-manualBackupLibsql

backup-manualBackupLibsql

backup-manualBackupWebServer

backup-manualBackupWebServer

backup-listBackupFiles

backup-listBackupFiles

read-only idempotent

Capability Spec

dokploy-backup.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Dokploy API — backup
  description: 'Dokploy API — backup. 12 operations. Lead operation: backup.create. Self-contained Naftiko capability covering one Dokploy business
    surface.'
  tags:
  - Dokploy
  - backup
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    DOKPLOY_API_KEY: DOKPLOY_API_KEY
    DOKPLOY_URL: DOKPLOY_URL
capability:
  consumes:
  - type: http
    namespace: dokploy-backup
    baseUri: ${DOKPLOY_URL}/api
    description: Dokploy API — backup business capability. Self-contained, no shared references.
    resources:
    - name: create
      path: /backup.create
      operations:
      - name: backup-create
        method: POST
        description: backup-create
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: one
      path: /backup.one
      operations:
      - name: backup-one
        method: GET
        description: backup-one
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: update
      path: /backup.update
      operations:
      - name: backup-update
        method: POST
        description: backup-update
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: remove
      path: /backup.remove
      operations:
      - name: backup-remove
        method: POST
        description: backup-remove
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: manualBackupPostgres
      path: /backup.manualBackupPostgres
      operations:
      - name: backup-manualBackupPostgres
        method: POST
        description: backup-manualBackupPostgres
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: manualBackupMySql
      path: /backup.manualBackupMySql
      operations:
      - name: backup-manualBackupMySql
        method: POST
        description: backup-manualBackupMySql
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: manualBackupMariadb
      path: /backup.manualBackupMariadb
      operations:
      - name: backup-manualBackupMariadb
        method: POST
        description: backup-manualBackupMariadb
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: manualBackupCompose
      path: /backup.manualBackupCompose
      operations:
      - name: backup-manualBackupCompose
        method: POST
        description: backup-manualBackupCompose
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: manualBackupMongo
      path: /backup.manualBackupMongo
      operations:
      - name: backup-manualBackupMongo
        method: POST
        description: backup-manualBackupMongo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: manualBackupLibsql
      path: /backup.manualBackupLibsql
      operations:
      - name: backup-manualBackupLibsql
        method: POST
        description: backup-manualBackupLibsql
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: manualBackupWebServer
      path: /backup.manualBackupWebServer
      operations:
      - name: backup-manualBackupWebServer
        method: POST
        description: backup-manualBackupWebServer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: listBackupFiles
      path: /backup.listBackupFiles
      operations:
      - name: backup-listBackupFiles
        method: GET
        description: backup-listBackupFiles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: dokploy-backup-rest
    port: 8080
    description: REST adapter for Dokploy API — backup. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/backup.create
      name: create
      description: REST surface for create.
      operations:
      - method: POST
        name: backup-create
        description: backup-create
        call: dokploy-backup.backup-create
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.one
      name: one
      description: REST surface for one.
      operations:
      - method: GET
        name: backup-one
        description: backup-one
        call: dokploy-backup.backup-one
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.update
      name: update
      description: REST surface for update.
      operations:
      - method: POST
        name: backup-update
        description: backup-update
        call: dokploy-backup.backup-update
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.remove
      name: remove
      description: REST surface for remove.
      operations:
      - method: POST
        name: backup-remove
        description: backup-remove
        call: dokploy-backup.backup-remove
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.manualBackupPostgres
      name: manualBackupPostgres
      description: REST surface for manualBackupPostgres.
      operations:
      - method: POST
        name: backup-manualBackupPostgres
        description: backup-manualBackupPostgres
        call: dokploy-backup.backup-manualBackupPostgres
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.manualBackupMySql
      name: manualBackupMySql
      description: REST surface for manualBackupMySql.
      operations:
      - method: POST
        name: backup-manualBackupMySql
        description: backup-manualBackupMySql
        call: dokploy-backup.backup-manualBackupMySql
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.manualBackupMariadb
      name: manualBackupMariadb
      description: REST surface for manualBackupMariadb.
      operations:
      - method: POST
        name: backup-manualBackupMariadb
        description: backup-manualBackupMariadb
        call: dokploy-backup.backup-manualBackupMariadb
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.manualBackupCompose
      name: manualBackupCompose
      description: REST surface for manualBackupCompose.
      operations:
      - method: POST
        name: backup-manualBackupCompose
        description: backup-manualBackupCompose
        call: dokploy-backup.backup-manualBackupCompose
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.manualBackupMongo
      name: manualBackupMongo
      description: REST surface for manualBackupMongo.
      operations:
      - method: POST
        name: backup-manualBackupMongo
        description: backup-manualBackupMongo
        call: dokploy-backup.backup-manualBackupMongo
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.manualBackupLibsql
      name: manualBackupLibsql
      description: REST surface for manualBackupLibsql.
      operations:
      - method: POST
        name: backup-manualBackupLibsql
        description: backup-manualBackupLibsql
        call: dokploy-backup.backup-manualBackupLibsql
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.manualBackupWebServer
      name: manualBackupWebServer
      description: REST surface for manualBackupWebServer.
      operations:
      - method: POST
        name: backup-manualBackupWebServer
        description: backup-manualBackupWebServer
        call: dokploy-backup.backup-manualBackupWebServer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/backup.listBackupFiles
      name: listBackupFiles
      description: REST surface for listBackupFiles.
      operations:
      - method: GET
        name: backup-listBackupFiles
        description: backup-listBackupFiles
        call: dokploy-backup.backup-listBackupFiles
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: dokploy-backup-mcp
    port: 9090
    transport: http
    description: MCP adapter for Dokploy API — backup. One tool per consumed operation, routed inline through this capability’s consumes block.
    tools:
    - name: backup-create
      description: backup-create
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-create
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-one
      description: backup-one
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: dokploy-backup.backup-one
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-update
      description: backup-update
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-update
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-remove
      description: backup-remove
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-remove
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-manualBackupPostgres
      description: backup-manualBackupPostgres
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-manualBackupPostgres
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-manualBackupMySql
      description: backup-manualBackupMySql
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-manualBackupMySql
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-manualBackupMariadb
      description: backup-manualBackupMariadb
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-manualBackupMariadb
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-manualBackupCompose
      description: backup-manualBackupCompose
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-manualBackupCompose
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-manualBackupMongo
      description: backup-manualBackupMongo
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-manualBackupMongo
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-manualBackupLibsql
      description: backup-manualBackupLibsql
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-manualBackupLibsql
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-manualBackupWebServer
      description: backup-manualBackupWebServer
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dokploy-backup.backup-manualBackupWebServer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: backup-listBackupFiles
      description: backup-listBackupFiles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: dokploy-backup.backup-listBackupFiles
      outputParameters:
      - type: object
        mapping: $.