/
DO
dokploy
/
Dokploy API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 5h ago · Updated 5h ago
View markdown
dokploy
Dokploy API
post
/settings.assignDomainServer
latest
OpenAPI 3.1.0
Apache 2.0
2026-08-15
597
5
1.7 MB
8d66aacade7f
admin
1
ai
14
application
31
auditLog
1
backup
12
bitbucket
7
certificates
5
cluster
4
compose
31
customRole
6
deployment
9
destination
6
dnsProvider
11
docker
18
dockerDiskUsage
3
dockerImage
3
dockerVolume
8
domain
10
environment
7
forwardAuth
10
gitea
8
github
6
gitlab
7
gitProvider
4
libsql
14
licenseKey
6
mariadb
16
mongo
16
mounts
6
mysql
16
network
8
notification
41
organization
11
overview
3
patch
12
port
4
postgres
16
previewDeployment
4
project
9
redirects
4
redis
16
registry
7
rollback
2
schedule
6
scim
3
security
4
server
18
settings
52
get
/settings.getWebServerSettings
post
/settings.reloadServer
post
/settings.cleanAllDeploymentQueue
post
/settings.reloadTraefik
post
/settings.toggleDashboard
post
/settings.cleanUnusedImages
post
/settings.cleanUnusedVolumes
post
/settings.cleanStoppedContainers
post
/settings.cleanDockerBuilder
post
/settings.cleanDockerPrune
post
/settings.cleanAll
post
/settings.cleanMonitoring
get
/settings.getDockerDiskUsage
post
/settings.saveSSHPrivateKey
post
/settings.assignDomainServer
post
/settings.cleanSSHPrivateKey
post
/settings.updateDockerCleanup
post
/settings.updateRemoteServersOnly
post
/settings.updateBuildsConcurrency
post
/settings.updateEnforceSSO
get
/settings.readTraefikConfig
post
/settings.updateTraefikConfig
get
/settings.readWebServerTraefikConfig
post
/settings.updateWebServerTraefikConfig
get
/settings.readMiddlewareTraefikConfig
post
/settings.updateMiddlewareTraefikConfig
post
/settings.getUpdateData
post
/settings.updateServer
get
/settings.getDokployVersion
get
/settings.getReleaseTag
get
/settings.readDirectories
post
/settings.updateTraefikFile
get
/settings.readTraefikFile
get
/settings.getIp
post
/settings.updateServerIp
get
/settings.getOpenApiDocument
get
/settings.readTraefikEnv
post
/settings.writeTraefikEnv
get
/settings.haveTraefikDashboardPortEnabled
get
/settings.haveActivateRequests
post
/settings.toggleRequests
get
/settings.isCloud
get
/settings.isUserSubscribed
get
/settings.health
get
/settings.checkInfrastructureHealth
post
/settings.setupGPU
get
/settings.checkGPUStatus
post
/settings.updateTraefikPorts
get
/settings.getTraefikPorts
post
/settings.updateLogCleanup
get
/settings.getLogCleanupStatus
get
/settings.getDokployCloudIps
sshKey
7
sso
11
stripe
8
swarm
4
tag
8
user
26
vaultProvider
7
volumeBackups
6
whitelabeling
4
settings
post
/settings.assignDomainServer
Request body
object
required
host
string
required
certificateType
'letsencrypt'
|
'none'
|
'custom'
required
letsEncryptEmail
union
https
boolean
Response
Successful response
object
required