Dokploy · Capability

Dokploy API — settings

Dokploy API — settings. 51 operations. Lead operation: settings.getWebServerSettings. Self-contained Naftiko capability covering one Dokploy business surface.

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

The capability includes 22 read-only operations and 29 state-changing operations. Lead operation: settings-getWebServerSettings. Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Tagged areas include Dokploy and settings.

Run with Naftiko Dokploysettings

What You Can Do

GET
Settings getwebserversettings — settings-getWebServerSettings
/v1/settings.getWebServerSettings
POST
Settings reloadserver — settings-reloadServer
/v1/settings.reloadServer
POST
Settings cleanredis — settings-cleanRedis
/v1/settings.cleanRedis
POST
Settings reloadredis — settings-reloadRedis
/v1/settings.reloadRedis
POST
Settings cleanalldeploymentqueue — settings-cleanAllDeploymentQueue
/v1/settings.cleanAllDeploymentQueue
POST
Settings reloadtraefik — settings-reloadTraefik
/v1/settings.reloadTraefik
POST
Settings toggledashboard — settings-toggleDashboard
/v1/settings.toggleDashboard
POST
Settings cleanunusedimages — settings-cleanUnusedImages
/v1/settings.cleanUnusedImages
POST
Settings cleanunusedvolumes — settings-cleanUnusedVolumes
/v1/settings.cleanUnusedVolumes
POST
Settings cleanstoppedcontainers — settings-cleanStoppedContainers
/v1/settings.cleanStoppedContainers
POST
Settings cleandockerbuilder — settings-cleanDockerBuilder
/v1/settings.cleanDockerBuilder
POST
Settings cleandockerprune — settings-cleanDockerPrune
/v1/settings.cleanDockerPrune
POST
Settings cleanall — settings-cleanAll
/v1/settings.cleanAll
POST
Settings cleanmonitoring — settings-cleanMonitoring
/v1/settings.cleanMonitoring
GET
Settings getdockerdiskusage — settings-getDockerDiskUsage
/v1/settings.getDockerDiskUsage
POST
Settings savesshprivatekey — settings-saveSSHPrivateKey
/v1/settings.saveSSHPrivateKey
POST
Settings assigndomainserver — settings-assignDomainServer
/v1/settings.assignDomainServer
POST
Settings cleansshprivatekey — settings-cleanSSHPrivateKey
/v1/settings.cleanSSHPrivateKey
POST
Settings updatedockercleanup — settings-updateDockerCleanup
/v1/settings.updateDockerCleanup
GET
Settings readtraefikconfig — settings-readTraefikConfig
/v1/settings.readTraefikConfig
POST
Settings updatetraefikconfig — settings-updateTraefikConfig
/v1/settings.updateTraefikConfig
GET
Settings readwebservertraefikconfig — settings-readWebServerTraefikConfig
/v1/settings.readWebServerTraefikConfig
POST
Settings updatewebservertraefikconfig — settings-updateWebServerTraefikConfig
/v1/settings.updateWebServerTraefikConfig
GET
Settings readmiddlewaretraefikconfig — settings-readMiddlewareTraefikConfig
/v1/settings.readMiddlewareTraefikConfig
POST
Settings updatemiddlewaretraefikconfig — settings-updateMiddlewareTraefikConfig
/v1/settings.updateMiddlewareTraefikConfig
POST
Settings getupdatedata — settings-getUpdateData
/v1/settings.getUpdateData
POST
Settings updateserver — settings-updateServer
/v1/settings.updateServer
GET
Settings getdokployversion — settings-getDokployVersion
/v1/settings.getDokployVersion
GET
Settings getreleasetag — settings-getReleaseTag
/v1/settings.getReleaseTag
GET
Settings readdirectories — settings-readDirectories
/v1/settings.readDirectories
POST
Settings updatetraefikfile — settings-updateTraefikFile
/v1/settings.updateTraefikFile
GET
Settings readtraefikfile — settings-readTraefikFile
/v1/settings.readTraefikFile
GET
Settings getip — settings-getIp
/v1/settings.getIp
POST
Settings updateserverip — settings-updateServerIp
/v1/settings.updateServerIp
GET
Settings getopenapidocument — settings-getOpenApiDocument
/v1/settings.getOpenApiDocument
GET
Settings readtraefikenv — settings-readTraefikEnv
/v1/settings.readTraefikEnv
POST
Settings writetraefikenv — settings-writeTraefikEnv
/v1/settings.writeTraefikEnv
GET
Settings havetraefikdashboardportenabled — settings-haveTraefikDashboardPortEnabled
/v1/settings.haveTraefikDashboardPortEnabled
GET
Settings haveactivaterequests — settings-haveActivateRequests
/v1/settings.haveActivateRequests
POST
Settings togglerequests — settings-toggleRequests
/v1/settings.toggleRequests
GET
Settings iscloud — settings-isCloud
/v1/settings.isCloud
GET
Settings isusersubscribed — settings-isUserSubscribed
/v1/settings.isUserSubscribed
GET
Settings health — settings-health
/v1/settings.health
GET
Settings checkinfrastructurehealth — settings-checkInfrastructureHealth
/v1/settings.checkInfrastructureHealth
POST
Settings setupgpu — settings-setupGPU
/v1/settings.setupGPU
GET
Settings checkgpustatus — settings-checkGPUStatus
/v1/settings.checkGPUStatus
POST
Settings updatetraefikports — settings-updateTraefikPorts
/v1/settings.updateTraefikPorts
GET
Settings gettraefikports — settings-getTraefikPorts
/v1/settings.getTraefikPorts
POST
Settings updatelogcleanup — settings-updateLogCleanup
/v1/settings.updateLogCleanup
GET
Settings getlogcleanupstatus — settings-getLogCleanupStatus
/v1/settings.getLogCleanupStatus
GET
Settings getdokploycloudips — settings-getDokployCloudIps
/v1/settings.getDokployCloudIps

MCP Tools

settings-getWebServerSettings

settings-getWebServerSettings

read-only idempotent
settings-reloadServer

settings-reloadServer

settings-cleanRedis

settings-cleanRedis

settings-reloadRedis

settings-reloadRedis

settings-cleanAllDeploymentQueue

settings-cleanAllDeploymentQueue

settings-reloadTraefik

settings-reloadTraefik

settings-toggleDashboard

settings-toggleDashboard

settings-cleanUnusedImages

settings-cleanUnusedImages

settings-cleanUnusedVolumes

settings-cleanUnusedVolumes

settings-cleanStoppedContainers

settings-cleanStoppedContainers

settings-cleanDockerBuilder

settings-cleanDockerBuilder

settings-cleanDockerPrune

settings-cleanDockerPrune

settings-cleanAll

settings-cleanAll

settings-cleanMonitoring

settings-cleanMonitoring

settings-getDockerDiskUsage

settings-getDockerDiskUsage

read-only idempotent
settings-saveSSHPrivateKey

settings-saveSSHPrivateKey

settings-assignDomainServer

settings-assignDomainServer

settings-cleanSSHPrivateKey

settings-cleanSSHPrivateKey

settings-updateDockerCleanup

settings-updateDockerCleanup

settings-readTraefikConfig

settings-readTraefikConfig

read-only idempotent
settings-updateTraefikConfig

settings-updateTraefikConfig

settings-readWebServerTraefikConfig

settings-readWebServerTraefikConfig

read-only idempotent
settings-updateWebServerTraefikConfig

settings-updateWebServerTraefikConfig

settings-readMiddlewareTraefikConfig

settings-readMiddlewareTraefikConfig

read-only idempotent
settings-updateMiddlewareTraefikConfig

settings-updateMiddlewareTraefikConfig

settings-getUpdateData

settings-getUpdateData

settings-updateServer

settings-updateServer

settings-getDokployVersion

settings-getDokployVersion

read-only idempotent
settings-getReleaseTag

settings-getReleaseTag

read-only idempotent
settings-readDirectories

settings-readDirectories

read-only idempotent
settings-updateTraefikFile

settings-updateTraefikFile

settings-readTraefikFile

settings-readTraefikFile

read-only idempotent
settings-getIp

settings-getIp

read-only idempotent
settings-updateServerIp

settings-updateServerIp

settings-getOpenApiDocument

settings-getOpenApiDocument

read-only idempotent
settings-readTraefikEnv

settings-readTraefikEnv

read-only idempotent
settings-writeTraefikEnv

settings-writeTraefikEnv

settings-haveTraefikDashboardPortEnabled

settings-haveTraefikDashboardPortEnabled

read-only idempotent
settings-haveActivateRequests

settings-haveActivateRequests

read-only idempotent
settings-toggleRequests

settings-toggleRequests

settings-isCloud

settings-isCloud

read-only idempotent
settings-isUserSubscribed

settings-isUserSubscribed

read-only idempotent
settings-health

settings-health

read-only idempotent
settings-checkInfrastructureHealth

settings-checkInfrastructureHealth

read-only idempotent
settings-setupGPU

settings-setupGPU

settings-checkGPUStatus

settings-checkGPUStatus

read-only idempotent
settings-updateTraefikPorts

settings-updateTraefikPorts

settings-getTraefikPorts

settings-getTraefikPorts

read-only idempotent
settings-updateLogCleanup

settings-updateLogCleanup

settings-getLogCleanupStatus

settings-getLogCleanupStatus

read-only idempotent
settings-getDokployCloudIps

settings-getDokployCloudIps

read-only idempotent

Capability Spec

dokploy-settings.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Dokploy API — settings
  description: 'Dokploy API — settings. 51 operations. Lead operation: settings.getWebServerSettings. Self-contained Naftiko capability covering
    one Dokploy business surface.'
  tags:
  - Dokploy
  - settings
  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-settings
    baseUri: ${DOKPLOY_URL}/api
    description: Dokploy API — settings business capability. Self-contained, no shared references.
    resources:
    - name: getWebServerSettings
      path: /settings.getWebServerSettings
      operations:
      - name: settings-getWebServerSettings
        method: GET
        description: settings-getWebServerSettings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: reloadServer
      path: /settings.reloadServer
      operations:
      - name: settings-reloadServer
        method: POST
        description: settings-reloadServer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cleanRedis
      path: /settings.cleanRedis
      operations:
      - name: settings-cleanRedis
        method: POST
        description: settings-cleanRedis
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: reloadRedis
      path: /settings.reloadRedis
      operations:
      - name: settings-reloadRedis
        method: POST
        description: settings-reloadRedis
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cleanAllDeploymentQueue
      path: /settings.cleanAllDeploymentQueue
      operations:
      - name: settings-cleanAllDeploymentQueue
        method: POST
        description: settings-cleanAllDeploymentQueue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: reloadTraefik
      path: /settings.reloadTraefik
      operations:
      - name: settings-reloadTraefik
        method: POST
        description: settings-reloadTraefik
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: toggleDashboard
      path: /settings.toggleDashboard
      operations:
      - name: settings-toggleDashboard
        method: POST
        description: settings-toggleDashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: cleanUnusedImages
      path: /settings.cleanUnusedImages
      operations:
      - name: settings-cleanUnusedImages
        method: POST
        description: settings-cleanUnusedImages
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: cleanUnusedVolumes
      path: /settings.cleanUnusedVolumes
      operations:
      - name: settings-cleanUnusedVolumes
        method: POST
        description: settings-cleanUnusedVolumes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: cleanStoppedContainers
      path: /settings.cleanStoppedContainers
      operations:
      - name: settings-cleanStoppedContainers
        method: POST
        description: settings-cleanStoppedContainers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: cleanDockerBuilder
      path: /settings.cleanDockerBuilder
      operations:
      - name: settings-cleanDockerBuilder
        method: POST
        description: settings-cleanDockerBuilder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: cleanDockerPrune
      path: /settings.cleanDockerPrune
      operations:
      - name: settings-cleanDockerPrune
        method: POST
        description: settings-cleanDockerPrune
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: cleanAll
      path: /settings.cleanAll
      operations:
      - name: settings-cleanAll
        method: POST
        description: settings-cleanAll
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: cleanMonitoring
      path: /settings.cleanMonitoring
      operations:
      - name: settings-cleanMonitoring
        method: POST
        description: settings-cleanMonitoring
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: getDockerDiskUsage
      path: /settings.getDockerDiskUsage
      operations:
      - name: settings-getDockerDiskUsage
        method: GET
        description: settings-getDockerDiskUsage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: saveSSHPrivateKey
      path: /settings.saveSSHPrivateKey
      operations:
      - name: settings-saveSSHPrivateKey
        method: POST
        description: settings-saveSSHPrivateKey
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: assignDomainServer
      path: /settings.assignDomainServer
      operations:
      - name: settings-assignDomainServer
        method: POST
        description: settings-assignDomainServer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: cleanSSHPrivateKey
      path: /settings.cleanSSHPrivateKey
      operations:
      - name: settings-cleanSSHPrivateKey
        method: POST
        description: settings-cleanSSHPrivateKey
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateDockerCleanup
      path: /settings.updateDockerCleanup
      operations:
      - name: settings-updateDockerCleanup
        method: POST
        description: settings-updateDockerCleanup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: readTraefikConfig
      path: /settings.readTraefikConfig
      operations:
      - name: settings-readTraefikConfig
        method: GET
        description: settings-readTraefikConfig
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateTraefikConfig
      path: /settings.updateTraefikConfig
      operations:
      - name: settings-updateTraefikConfig
        method: POST
        description: settings-updateTraefikConfig
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: readWebServerTraefikConfig
      path: /settings.readWebServerTraefikConfig
      operations:
      - name: settings-readWebServerTraefikConfig
        method: GET
        description: settings-readWebServerTraefikConfig
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateWebServerTraefikConfig
      path: /settings.updateWebServerTraefikConfig
      operations:
      - name: settings-updateWebServerTraefikConfig
        method: POST
        description: settings-updateWebServerTraefikConfig
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: readMiddlewareTraefikConfig
      path: /settings.readMiddlewareTraefikConfig
      operations:
      - name: settings-readMiddlewareTraefikConfig
        method: GET
        description: settings-readMiddlewareTraefikConfig
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateMiddlewareTraefikConfig
      path: /settings.updateMiddlewareTraefikConfig
      operations:
      - name: settings-updateMiddlewareTraefikConfig
        method: POST
        description: settings-updateMiddlewareTraefikConfig
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: getUpdateData
      path: /settings.getUpdateData
      operations:
      - name: settings-getUpdateData
        method: POST
        description: settings-getUpdateData
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateServer
      path: /settings.updateServer
      operations:
      - name: settings-updateServer
        method: POST
        description: settings-updateServer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: getDokployVersion
      path: /settings.getDokployVersion
      operations:
      - name: settings-getDokployVersion
        method: GET
        description: settings-getDokployVersion
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: getReleaseTag
      path: /settings.getReleaseTag
      operations:
      - name: settings-getReleaseTag
        method: GET
        description: settings-getReleaseTag
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: readDirectories
      path: /settings.readDirectories
      operations:
      - name: settings-readDirectories
        method: GET
        description: settings-readDirectories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateTraefikFile
      path: /settings.updateTraefikFile
      operations:
      - name: settings-updateTraefikFile
        method: POST
        description: settings-updateTraefikFile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: readTraefikFile
      path: /settings.readTraefikFile
      operations:
      - name: settings-readTraefikFile
        method: GET
        description: settings-readTraefikFile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: getIp
      path: /settings.getIp
      operations:
      - name: settings-getIp
        method: GET
        description: settings-getIp
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateServerIp
      path: /settings.updateServerIp
      operations:
      - name: settings-updateServerIp
        method: POST
        description: settings-updateServerIp
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: getOpenApiDocument
      path: /settings.getOpenApiDocument
      operations:
      - name: settings-getOpenApiDocument
        method: GET
        description: settings-getOpenApiDocument
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: readTraefikEnv
      path: /settings.readTraefikEnv
      operations:
      - name: settings-readTraefikEnv
        method: GET
        description: settings-readTraefikEnv
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: writeTraefikEnv
      path: /settings.writeTraefikEnv
      operations:
      - name: settings-writeTraefikEnv
        method: POST
        description: settings-writeTraefikEnv
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: haveTraefikDashboardPortEnabled
      path: /settings.haveTraefikDashboardPortEnabled
      operations:
      - name: settings-haveTraefikDashboardPortEnabled
        method: GET
        description: settings-haveTraefikDashboardPortEnabled
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: haveActivateRequests
      path: /settings.haveActivateRequests
      operations:
      - name: settings-haveActivateRequests
        method: GET
        description: settings-haveActivateRequests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: toggleRequests
      path: /settings.toggleRequests
      operations:
      - name: settings-toggleRequests
        method: POST
        description: settings-toggleRequests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: isCloud
      path: /settings.isCloud
      operations:
      - name: settings-isCloud
        method: GET
        description: settings-isCloud
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: isUserSubscribed
      path: /settings.isUserSubscribed
      operations:
      - name: settings-isUserSubscribed
        method: GET
        description: settings-isUserSubscribed
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: health
      path: /settings.health
      operations:
      - name: settings-health
        method: GET
        description: settings-health
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: checkInfrastructureHealth
      path: /settings.checkInfrastructureHealth
      operations:
      - name: settings-checkInfrastructureHealth
        method: GET
        description: settings-checkInfrastructureHealth
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: setupGPU
      path: /settings.setupGPU
      operations:
      - name: settings-setupGPU
        method: POST
        description: settings-setupGPU
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: checkGPUStatus
      path: /settings.checkGPUStatus
      operations:
      - name: settings-checkGPUStatus
        method: GET
        description: settings-checkGPUStatus
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateTraefikPorts
      path: /settings.updateTraefikPorts
      operations:
      - name: settings-updateTraefikPorts
        method: POST
        description: settings-updateTraefikPorts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: getTraefikPorts
      path: /settings.getTraefikPorts
      operations:
      - name: settings-getTraefikPorts
        method: GET
        description: settings-getTraefikPorts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: updateLogCleanup
      path: /settings.updateLogCleanup
      operations:
      - name: settings-updateLogCleanup
        method: POST
        description: settings-updateLogCleanup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: getLogCleanupStatus
      path: /settings.getLogCleanupStatus
      operations:
      - name: settings-getLogCleanupStatus
        method: GET
        description: settings-getLogCleanupStatus
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: getDokployCloudIps
      path: /settings.getDokployCloudIps
      operations:
      - name: settings-getDokployCloudIps
        method: GET
        description: settings-getDokployCloudIps
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: dokploy-settings-rest
    port: 8080
    description: REST adapter for Dokploy API — settings. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/settings.getWebServerSettings
      name: getWebServerSettings
      description: REST surface for getWebServerSettings.
      operations:
      - method: GET
        name: settings-getWebServerSettings
        description: settings-getWebServerSettings
        call: dokploy-settings.settings-getWebServerSettings
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.reloadServer
      name: reloadServer
      description: REST surface for reloadServer.
      operations:
      - method: POST
        name: settings-reloadServer
        description: settings-reloadServer
        call: dokploy-settings.settings-reloadServer
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanRedis
      name: cleanRedis
      description: REST surface for cleanRedis.
      operations:
      - method: POST
        name: settings-cleanRedis
        description: settings-cleanRedis
        call: dokploy-settings.settings-cleanRedis
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.reloadRedis
      name: reloadRedis
      description: REST surface for reloadRedis.
      operations:
      - method: POST
        name: settings-reloadRedis
        description: settings-reloadRedis
        call: dokploy-settings.settings-reloadRedis
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanAllDeploymentQueue
      name: cleanAllDeploymentQueue
      description: REST surface for cleanAllDeploymentQueue.
      operations:
      - method: POST
        name: settings-cleanAllDeploymentQueue
        description: settings-cleanAllDeploymentQueue
        call: dokploy-settings.settings-cleanAllDeploymentQueue
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.reloadTraefik
      name: reloadTraefik
      description: REST surface for reloadTraefik.
      operations:
      - method: POST
        name: settings-reloadTraefik
        description: settings-reloadTraefik
        call: dokploy-settings.settings-reloadTraefik
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.toggleDashboard
      name: toggleDashboard
      description: REST surface for toggleDashboard.
      operations:
      - method: POST
        name: settings-toggleDashboard
        description: settings-toggleDashboard
        call: dokploy-settings.settings-toggleDashboard
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanUnusedImages
      name: cleanUnusedImages
      description: REST surface for cleanUnusedImages.
      operations:
      - method: POST
        name: settings-cleanUnusedImages
        description: settings-cleanUnusedImages
        call: dokploy-settings.settings-cleanUnusedImages
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanUnusedVolumes
      name: cleanUnusedVolumes
      description: REST surface for cleanUnusedVolumes.
      operations:
      - method: POST
        name: settings-cleanUnusedVolumes
        description: settings-cleanUnusedVolumes
        call: dokploy-settings.settings-cleanUnusedVolumes
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanStoppedContainers
      name: cleanStoppedContainers
      description: REST surface for cleanStoppedContainers.
      operations:
      - method: POST
        name: settings-cleanStoppedContainers
        description: settings-cleanStoppedContainers
        call: dokploy-settings.settings-cleanStoppedContainers
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanDockerBuilder
      name: cleanDockerBuilder
      description: REST surface for cleanDockerBuilder.
      operations:
      - method: POST
        name: settings-cleanDockerBuilder
        description: settings-cleanDockerBuilder
        call: dokploy-settings.settings-cleanDockerBuilder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanDockerPrune
      name: cleanDockerPrune
      description: REST surface for cleanDockerPrune.
      operations:
      - method: POST
        name: settings-cleanDockerPrune
        description: settings-cleanDockerPrune
        call: dokploy-settings.settings-cleanDockerPrune
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanAll
      name: cleanAll
      description: REST surface for cleanAll.
      operations:
      - method: POST
        name: settings-cleanAll
        description: settings-cleanAll
        call: dokploy-settings.settings-cleanAll
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanMonitoring
      name: cleanMonitoring
      description: REST surface for cleanMonitoring.
      operations:
      - method: POST
        name: settings-cleanMonitoring
        description: settings-cleanMonitoring
        call: dokploy-settings.settings-cleanMonitoring
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.getDockerDiskUsage
      name: getDockerDiskUsage
      description: REST surface for getDockerDiskUsage.
      operations:
      - method: GET
        name: settings-getDockerDiskUsage
        description: settings-getDockerDiskUsage
        call: dokploy-settings.settings-getDockerDiskUsage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.saveSSHPrivateKey
      name: saveSSHPrivateKey
      description: REST surface for saveSSHPrivateKey.
      operations:
      - method: POST
        name: settings-saveSSHPrivateKey
        description: settings-saveSSHPrivateKey
        call: dokploy-settings.settings-saveSSHPrivateKey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.assignDomainServer
      name: assignDomainServer
      description: REST surface for assignDomainServer.
      operations:
      - method: POST
        name: settings-assignDomainServer
        description: settings-assignDomainServer
        call: dokploy-settings.settings-assignDomainServer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.cleanSSHPrivateKey
      name: cleanSSHPrivateKey
      description: REST surface for cleanSSHPrivateKey.
      operations:
      - method: POST
        name: settings-cleanSSHPrivateKey
        description: settings-cleanSSHPrivateKey
        call: dokploy-settings.settings-cleanSSHPrivateKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.updateDockerCleanup
      name: updateDockerCleanup
      description: REST surface for updateDockerCleanup.
      operations:
      - method: POST
        name: settings-updateDockerCleanup
        description: settings-updateDockerCleanup
        call: dokploy-settings.settings-updateDockerCleanup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.readTraefikConfig
      name: readTraefikConfig
      description: REST surface for readTraefikConfig.
      operations:
      - method: GET
        name: settings-readTraefikConfig
        description: settings-readTraefikConfig
        call: dokploy-settings.settings-readTraefikConfig
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.updateTraefikConfig
      name: updateTraefikConfig
      description: REST surface for updateTraefikConfig.
      operations:
      - method: POST
        name: settings-updateTraefikConfig
        description: settings-updateTraefikConfig
        call: dokploy-settings.settings-updateTraefikConfig
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.readWebServerTraefikConfig
      name: readWebServerTraefikConfig
      description: REST surface for readWebServerTraefikConfig.
      operations:
      - method: GET
        name: settings-readWebServerTraefikConfig
        description: settings-readWebServerTraefikConfig
        call: dokploy-settings.settings-readWebServerTraefikConfig
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.updateWebServerTraefikConfig
      name: updateWebServerTraefikConfig
      description: REST surface for updateWebServerTraefikConfig.
      operations:
      - method: POST
        name: settings-updateWebServerTraefikConfig
        description: settings-updateWebServerTraefikConfig
        call: dokploy-settings.settings-updateWebServerTraefikConfig
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.readMiddlewareTraefikConfig
      name: readMiddlewareTraefikConfig
      description: REST surface for readMiddlewareTraefikConfig.
      operations:
      - method: GET
        name: settings-readMiddlewareTraefikConfig
        description: settings-readMiddlewareTraefikConfig
        call: dokploy-settings.settings-readMiddlewareTraefikConfig
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.updateMiddlewareTraefikConfig
      name: updateMiddlewareTraefikConfig
      description: REST surface for updateMiddlewareTraefikConfig.
      operations:
      - method: POST
        name: settings-updateMiddlewareTraefikConfig
        description: settings-updateMiddlewareTraefikConfig
        call: dokploy-settings.settings-updateMiddlewareTraefikConfig
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.getUpdateData
      name: getUpdateData
      description: REST surface for getUpdateData.
      operations:
      - method: POST
        name: settings-getUpdateData
        description: settings-getUpdateData
        call: dokploy-settings.settings-getUpdateData
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.updateServer
      name: updateServer
      description: REST surface for updateServer.
      operations:
      - method: POST
        name: settings-updateServer
        description: settings-updateServer
        call: dokploy-settings.settings-updateServer
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.getDokployVersion
      name: getDokployVersion
      description: REST surface for getDokployVersion.
      operations:
      - method: GET
        name: settings-getDokployVersion
        description: settings-getDokployVersion
        call: dokploy-settings.settings-getDokployVersion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.getReleaseTag
      name: getReleaseTag
      description: REST surface for getReleaseTag.
      operations:
      - method: GET
        name: settings-getReleaseTag
        description: settings-getReleaseTag
        call: dokploy-settings.settings-getReleaseTag
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.readDirectories
      name: readDirectories
      description: REST surface for readDirectories.
      operations:
      - method: GET
        name: settings-readDirectories
        description: settings-readDirectories
        call: dokploy-settings.settings-readDirectories
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings.updateTraefikFile
      name: updateTraefikFile
      description: REST surface for updateTraefikFile.
      operations:
      - method: POST
        name: settings-updateTraefikFile
        description: settings-updateTraefikFile
        call: dokploy-settings.settings-updateTraefikFile
        with:
          body: rest.body
  

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/capabilities/dokploy-settings.yaml