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 outputParameters: - type: object mapping: $. - path: /v1/settings.readTraefikFile name: readTraefikFile description: REST surface for readTraefikFile. operations: - method: GET name: settings-readTraefikFile description: settings-readTraefikFile call: dokploy-settings.settings-readTraefikFile outputParameters: - type: object mapping: $. - path: /v1/settings.getIp name: getIp description: REST surface for getIp. operations: - method: GET name: settings-getIp description: settings-getIp call: dokploy-settings.settings-getIp outputParameters: - type: object mapping: $. - path: /v1/settings.updateServerIp name: updateServerIp description: REST surface for updateServerIp. operations: - method: POST name: settings-updateServerIp description: settings-updateServerIp call: dokploy-settings.settings-updateServerIp with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/settings.getOpenApiDocument name: getOpenApiDocument description: REST surface for getOpenApiDocument. operations: - method: GET name: settings-getOpenApiDocument description: settings-getOpenApiDocument call: dokploy-settings.settings-getOpenApiDocument outputParameters: - type: object mapping: $. - path: /v1/settings.readTraefikEnv name: readTraefikEnv description: REST surface for readTraefikEnv. operations: - method: GET name: settings-readTraefikEnv description: settings-readTraefikEnv call: dokploy-settings.settings-readTraefikEnv outputParameters: - type: object mapping: $. - path: /v1/settings.writeTraefikEnv name: writeTraefikEnv description: REST surface for writeTraefikEnv. operations: - method: POST name: settings-writeTraefikEnv description: settings-writeTraefikEnv call: dokploy-settings.settings-writeTraefikEnv with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/settings.haveTraefikDashboardPortEnabled name: haveTraefikDashboardPortEnabled description: REST surface for haveTraefikDashboardPortEnabled. operations: - method: GET name: settings-haveTraefikDashboardPortEnabled description: settings-haveTraefikDashboardPortEnabled call: dokploy-settings.settings-haveTraefikDashboardPortEnabled outputParameters: - type: object mapping: $. - path: /v1/settings.haveActivateRequests name: haveActivateRequests description: REST surface for haveActivateRequests. operations: - method: GET name: settings-haveActivateRequests description: settings-haveActivateRequests call: dokploy-settings.settings-haveActivateRequests outputParameters: - type: object mapping: $. - path: /v1/settings.toggleRequests name: toggleRequests description: REST surface for toggleRequests. operations: - method: POST name: settings-toggleRequests description: settings-toggleRequests call: dokploy-settings.settings-toggleRequests with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/settings.isCloud name: isCloud description: REST surface for isCloud. operations: - method: GET name: settings-isCloud description: settings-isCloud call: dokploy-settings.settings-isCloud outputParameters: - type: object mapping: $. - path: /v1/settings.isUserSubscribed name: isUserSubscribed description: REST surface for isUserSubscribed. operations: - method: GET name: settings-isUserSubscribed description: settings-isUserSubscribed call: dokploy-settings.settings-isUserSubscribed outputParameters: - type: object mapping: $. - path: /v1/settings.health name: health description: REST surface for health. operations: - method: GET name: settings-health description: settings-health call: dokploy-settings.settings-health outputParameters: - type: object mapping: $. - path: /v1/settings.checkInfrastructureHealth name: checkInfrastructureHealth description: REST surface for checkInfrastructureHealth. operations: - method: GET name: settings-checkInfrastructureHealth description: settings-checkInfrastructureHealth call: dokploy-settings.settings-checkInfrastructureHealth outputParameters: - type: object mapping: $. - path: /v1/settings.setupGPU name: setupGPU description: REST surface for setupGPU. operations: - method: POST name: settings-setupGPU description: settings-setupGPU call: dokploy-settings.settings-setupGPU with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/settings.checkGPUStatus name: checkGPUStatus description: REST surface for checkGPUStatus. operations: - method: GET name: settings-checkGPUStatus description: settings-checkGPUStatus call: dokploy-settings.settings-checkGPUStatus outputParameters: - type: object mapping: $. - path: /v1/settings.updateTraefikPorts name: updateTraefikPorts description: REST surface for updateTraefikPorts. operations: - method: POST name: settings-updateTraefikPorts description: settings-updateTraefikPorts call: dokploy-settings.settings-updateTraefikPorts with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/settings.getTraefikPorts name: getTraefikPorts description: REST surface for getTraefikPorts. operations: - method: GET name: settings-getTraefikPorts description: settings-getTraefikPorts call: dokploy-settings.settings-getTraefikPorts outputParameters: - type: object mapping: $. - path: /v1/settings.updateLogCleanup name: updateLogCleanup description: REST surface for updateLogCleanup. operations: - method: POST name: settings-updateLogCleanup description: settings-updateLogCleanup call: dokploy-settings.settings-updateLogCleanup with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/settings.getLogCleanupStatus name: getLogCleanupStatus description: REST surface for getLogCleanupStatus. operations: - method: GET name: settings-getLogCleanupStatus description: settings-getLogCleanupStatus call: dokploy-settings.settings-getLogCleanupStatus outputParameters: - type: object mapping: $. - path: /v1/settings.getDokployCloudIps name: getDokployCloudIps description: REST surface for getDokployCloudIps. operations: - method: GET name: settings-getDokployCloudIps description: settings-getDokployCloudIps call: dokploy-settings.settings-getDokployCloudIps outputParameters: - type: object mapping: $. - type: mcp namespace: dokploy-settings-mcp port: 9090 transport: http description: MCP adapter for Dokploy API — settings. One tool per consumed operation, routed inline through this capability’s consumes block. tools: - name: settings-getWebServerSettings description: settings-getWebServerSettings hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getWebServerSettings outputParameters: - type: object mapping: $. - name: settings-reloadServer description: settings-reloadServer hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-reloadServer outputParameters: - type: object mapping: $. - name: settings-cleanRedis description: settings-cleanRedis hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanRedis outputParameters: - type: object mapping: $. - name: settings-reloadRedis description: settings-reloadRedis hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-reloadRedis outputParameters: - type: object mapping: $. - name: settings-cleanAllDeploymentQueue description: settings-cleanAllDeploymentQueue hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanAllDeploymentQueue outputParameters: - type: object mapping: $. - name: settings-reloadTraefik description: settings-reloadTraefik hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-reloadTraefik with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-toggleDashboard description: settings-toggleDashboard hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-toggleDashboard with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-cleanUnusedImages description: settings-cleanUnusedImages hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanUnusedImages with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-cleanUnusedVolumes description: settings-cleanUnusedVolumes hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanUnusedVolumes with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-cleanStoppedContainers description: settings-cleanStoppedContainers hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanStoppedContainers with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-cleanDockerBuilder description: settings-cleanDockerBuilder hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanDockerBuilder with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-cleanDockerPrune description: settings-cleanDockerPrune hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanDockerPrune with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-cleanAll description: settings-cleanAll hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanAll with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-cleanMonitoring description: settings-cleanMonitoring hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanMonitoring outputParameters: - type: object mapping: $. - name: settings-getDockerDiskUsage description: settings-getDockerDiskUsage hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getDockerDiskUsage outputParameters: - type: object mapping: $. - name: settings-saveSSHPrivateKey description: settings-saveSSHPrivateKey hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-saveSSHPrivateKey with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-assignDomainServer description: settings-assignDomainServer hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-assignDomainServer with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-cleanSSHPrivateKey description: settings-cleanSSHPrivateKey hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-cleanSSHPrivateKey outputParameters: - type: object mapping: $. - name: settings-updateDockerCleanup description: settings-updateDockerCleanup hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateDockerCleanup with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-readTraefikConfig description: settings-readTraefikConfig hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-readTraefikConfig outputParameters: - type: object mapping: $. - name: settings-updateTraefikConfig description: settings-updateTraefikConfig hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateTraefikConfig with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-readWebServerTraefikConfig description: settings-readWebServerTraefikConfig hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-readWebServerTraefikConfig outputParameters: - type: object mapping: $. - name: settings-updateWebServerTraefikConfig description: settings-updateWebServerTraefikConfig hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateWebServerTraefikConfig with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-readMiddlewareTraefikConfig description: settings-readMiddlewareTraefikConfig hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-readMiddlewareTraefikConfig outputParameters: - type: object mapping: $. - name: settings-updateMiddlewareTraefikConfig description: settings-updateMiddlewareTraefikConfig hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateMiddlewareTraefikConfig with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-getUpdateData description: settings-getUpdateData hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-getUpdateData outputParameters: - type: object mapping: $. - name: settings-updateServer description: settings-updateServer hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateServer outputParameters: - type: object mapping: $. - name: settings-getDokployVersion description: settings-getDokployVersion hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getDokployVersion outputParameters: - type: object mapping: $. - name: settings-getReleaseTag description: settings-getReleaseTag hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getReleaseTag outputParameters: - type: object mapping: $. - name: settings-readDirectories description: settings-readDirectories hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-readDirectories outputParameters: - type: object mapping: $. - name: settings-updateTraefikFile description: settings-updateTraefikFile hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateTraefikFile with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-readTraefikFile description: settings-readTraefikFile hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-readTraefikFile outputParameters: - type: object mapping: $. - name: settings-getIp description: settings-getIp hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getIp outputParameters: - type: object mapping: $. - name: settings-updateServerIp description: settings-updateServerIp hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateServerIp with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-getOpenApiDocument description: settings-getOpenApiDocument hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getOpenApiDocument outputParameters: - type: object mapping: $. - name: settings-readTraefikEnv description: settings-readTraefikEnv hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-readTraefikEnv outputParameters: - type: object mapping: $. - name: settings-writeTraefikEnv description: settings-writeTraefikEnv hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-writeTraefikEnv with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-haveTraefikDashboardPortEnabled description: settings-haveTraefikDashboardPortEnabled hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-haveTraefikDashboardPortEnabled outputParameters: - type: object mapping: $. - name: settings-haveActivateRequests description: settings-haveActivateRequests hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-haveActivateRequests outputParameters: - type: object mapping: $. - name: settings-toggleRequests description: settings-toggleRequests hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-toggleRequests with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-isCloud description: settings-isCloud hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-isCloud outputParameters: - type: object mapping: $. - name: settings-isUserSubscribed description: settings-isUserSubscribed hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-isUserSubscribed outputParameters: - type: object mapping: $. - name: settings-health description: settings-health hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-health outputParameters: - type: object mapping: $. - name: settings-checkInfrastructureHealth description: settings-checkInfrastructureHealth hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-checkInfrastructureHealth outputParameters: - type: object mapping: $. - name: settings-setupGPU description: settings-setupGPU hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-setupGPU with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-checkGPUStatus description: settings-checkGPUStatus hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-checkGPUStatus outputParameters: - type: object mapping: $. - name: settings-updateTraefikPorts description: settings-updateTraefikPorts hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateTraefikPorts with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-getTraefikPorts description: settings-getTraefikPorts hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getTraefikPorts outputParameters: - type: object mapping: $. - name: settings-updateLogCleanup description: settings-updateLogCleanup hints: readOnly: false destructive: false idempotent: false call: dokploy-settings.settings-updateLogCleanup with: body: tools.body outputParameters: - type: object mapping: $. - name: settings-getLogCleanupStatus description: settings-getLogCleanupStatus hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getLogCleanupStatus outputParameters: - type: object mapping: $. - name: settings-getDokployCloudIps description: settings-getDokployCloudIps hints: readOnly: true destructive: false idempotent: true call: dokploy-settings.settings-getDokployCloudIps outputParameters: - type: object mapping: $.