How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dokploy settings API

The settings API from Dokploy — 51 operation(s) for settings.

Dokploy settings API is one of 48 APIs that Dokploy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Settings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and rate-limit docs.

This API exposes 51 operations across 51 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://your-dokploy-instance.com/api.

51 operations 51 paths 5 schemas 22 GET29 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://your-dokploy-instance.com/api
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Dokploy settings API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKey). By default, every request must be authenticated.

  • apiKey — API key authentication. Generate an API key from your Dokploy dashboard under Settings API Keys.

Paths & Operations 51

Across 51 paths, the API surfaces 51 operations — 22 GET, 29 POST. Each is listed below with its method, path, parameters, and response codes.

settings 51
GET
/settings.getWebServerSettings
settings-getWebServerSettings → 200400401403404500
POST
/settings.reloadServer
settings-reloadServer → 200400401403500
POST
/settings.cleanRedis
settings-cleanRedis → 200400401403500
POST
/settings.reloadRedis
settings-reloadRedis → 200400401403500
POST
/settings.cleanAllDeploymentQueue
settings-cleanAllDeploymentQueue → 200400401403500
POST
/settings.reloadTraefik
settings-reloadTraefik body → 200400401403500
POST
/settings.toggleDashboard
settings-toggleDashboard body → 200400401403500
POST
/settings.cleanUnusedImages
settings-cleanUnusedImages body → 200400401403500
POST
/settings.cleanUnusedVolumes
settings-cleanUnusedVolumes body → 200400401403500
POST
/settings.cleanStoppedContainers
settings-cleanStoppedContainers body → 200400401403500
POST
/settings.cleanDockerBuilder
settings-cleanDockerBuilder body → 200400401403500
POST
/settings.cleanDockerPrune
settings-cleanDockerPrune body → 200400401403500
POST
/settings.cleanAll
settings-cleanAll body → 200400401403500
POST
/settings.cleanMonitoring
settings-cleanMonitoring → 200400401403500
GET
/settings.getDockerDiskUsage
settings-getDockerDiskUsage → 200400401403404500
POST
/settings.saveSSHPrivateKey
settings-saveSSHPrivateKey body → 200400401403500
POST
/settings.assignDomainServer
settings-assignDomainServer body → 200400401403500
POST
/settings.cleanSSHPrivateKey
settings-cleanSSHPrivateKey → 200400401403500
POST
/settings.updateDockerCleanup
settings-updateDockerCleanup body → 200400401403500
GET
/settings.readTraefikConfig
settings-readTraefikConfig → 200400401403404500
POST
/settings.updateTraefikConfig
settings-updateTraefikConfig body → 200400401403500
GET
/settings.readWebServerTraefikConfig
settings-readWebServerTraefikConfig → 200400401403404500
POST
/settings.updateWebServerTraefikConfig
settings-updateWebServerTraefikConfig body → 200400401403500
GET
/settings.readMiddlewareTraefikConfig
settings-readMiddlewareTraefikConfig → 200400401403404500
POST
/settings.updateMiddlewareTraefikConfig
settings-updateMiddlewareTraefikConfig body → 200400401403500
POST
/settings.getUpdateData
settings-getUpdateData → 200400401403500
POST
/settings.updateServer
settings-updateServer → 200400401403500
GET
/settings.getDokployVersion
settings-getDokployVersion → 200400401403404500
GET
/settings.getReleaseTag
settings-getReleaseTag → 200400401403404500
GET
/settings.readDirectories
settings-readDirectories 1 param → 200400401403404500
POST
/settings.updateTraefikFile
settings-updateTraefikFile body → 200400401403500
GET
/settings.readTraefikFile
settings-readTraefikFile 2 params → 200400401403404500
GET
/settings.getIp
settings-getIp → 200400401403404500
POST
/settings.updateServerIp
settings-updateServerIp body → 200400401403500
GET
/settings.getOpenApiDocument
settings-getOpenApiDocument → 200400401403404500
GET
/settings.readTraefikEnv
settings-readTraefikEnv 1 param → 200400401403404500
POST
/settings.writeTraefikEnv
settings-writeTraefikEnv body → 200400401403500
GET
/settings.haveTraefikDashboardPortEnabled
settings-haveTraefikDashboardPortEnabled 1 param → 200400401403404500
GET
/settings.haveActivateRequests
settings-haveActivateRequests → 200400401403404500
POST
/settings.toggleRequests
settings-toggleRequests body → 200400401403500
GET
/settings.isCloud
settings-isCloud → 200400401403404500
GET
/settings.isUserSubscribed
settings-isUserSubscribed → 200400401403404500
GET
/settings.health
settings-health → 200400401403404500
GET
/settings.checkInfrastructureHealth
settings-checkInfrastructureHealth → 200400401403404500
POST
/settings.setupGPU
settings-setupGPU body → 200400401403500
GET
/settings.checkGPUStatus
settings-checkGPUStatus 1 param → 200400401403404500
POST
/settings.updateTraefikPorts
settings-updateTraefikPorts body → 200400401403500
GET
/settings.getTraefikPorts
settings-getTraefikPorts 1 param → 200400401403404500
POST
/settings.updateLogCleanup
settings-updateLogCleanup body → 200400401403500
GET
/settings.getLogCleanupStatus
settings-getLogCleanupStatus → 200400401403404500
GET
/settings.getDokployCloudIps
settings-getDokployCloudIps → 200400401403404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are error.BAD_REQUEST (3 properties), error.UNAUTHORIZED (3 properties), error.FORBIDDEN (3 properties), error.INTERNAL_SERVER_ERROR (3 properties). Each schema is shown below with its type and property counts.

error.NOT_FOUND
object
The error information
3 properties 2 required
error.INTERNAL_SERVER_ERROR
object
The error information
3 properties 2 required
error.FORBIDDEN
object
The error information
3 properties 2 required
error.UNAUTHORIZED
object
The error information
3 properties 2 required
error.BAD_REQUEST
object
The error information
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dokploy-settings-api-openapi.yml Raw ↑

Other APIs Dokploy publishes across the network.

Dokploy admin API
Dokploy ai API
Dokploy application API
Dokploy auditLog API
Dokploy backup API
Dokploy bitbucket API
Dokploy certificates API
Dokploy cluster API
Dokploy compose API
Dokploy customRole API
Dokploy deployment API
Dokploy destination API
Where this information came from

This is an independent, third-party profile of Dokploy settings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.