Settings
settings.reloadServer
Successful response
settings.reloadTraefik
Settings reload Traefik
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
OptionalserverId
string
Successful response
settings.toggleDashboard
Settings toggle Dashboard
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredenableDashboard
boolean
serverId
string
Successful response
settings.cleanUnusedImages
Settings clean Unused Images
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
OptionalserverId
string
Successful response
settings.cleanUnusedVolumes
Settings clean Unused Volumes
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
OptionalserverId
string
Successful response
settings.cleanStoppedContainers
Settings clean Stopped Containers
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
OptionalserverId
string
Successful response
settings.cleanDockerBuilder
Settings clean Docker Builder
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
OptionalserverId
string
Successful response
settings.cleanDockerPrune
Settings clean Docker Prune
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
OptionalserverId
string
Successful response
settings.cleanAll
Settings clean All
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
OptionalserverId
string
Successful response
settings.cleanMonitoring
Successful response
settings.saveSSHPrivateKey
Settings save S S H Private Key
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredsshPrivateKey
string | null
Successful response
settings.assignDomainServer
Settings assign Domain Server
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
Requiredhost
Requiredstring | null
certificateType
string
"none"
Value in: "letsencrypt" | "none"
letsEncryptEmail
string | null
Successful response
settings.cleanSSHPrivateKey
Successful response
settings.updateDockerCleanup
Settings update Docker Cleanup
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredenableDockerCleanup
Requiredboolean
serverId
string
Successful response
settings.readTraefikConfig
Successful response
settings.updateTraefikConfig
Settings update Traefik Config
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredtraefikConfig
Requiredstring
1
Successful response
settings.readWebServerTraefikConfig
Successful response
settings.updateWebServerTraefikConfig
Settings update Web Server Traefik Config
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredtraefikConfig
Requiredstring
1
Successful response
settings.readMiddlewareTraefikConfig
Successful response
settings.updateMiddlewareTraefikConfig
Settings update Middleware Traefik Config
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredtraefikConfig
Requiredstring
1
Successful response
settings.checkAndUpdateImage
Successful response
settings.updateServer
Successful response
settings.getDokployVersion
Successful response
settings.readDirectories
Settings read Directories
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
serverId
string
Successful response
settings.updateTraefikFile
Settings update Traefik File
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
Requiredpath
Requiredstring
1
traefikConfig
Requiredstring
1
serverId
string
Successful response
settings.readTraefikFile
Settings read Traefik File
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
path
Requiredstring
1
serverId
string
Successful response
settings.getIp
Successful response
settings.getOpenApiDocument
Successful response
settings.readTraefikEnv
Settings read Traefik Env
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
serverId
string
Successful response
settings.writeTraefikEnv
Settings write Traefik Env
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
Requiredenv
Requiredstring
serverId
string
Successful response
settings.haveTraefikDashboardPortEnabled
Settings have Traefik Dashboard Port Enabled
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
serverId
string
Successful response
settings.readStats
Successful response
settings.getLogRotateStatus
Successful response
settings.toggleLogRotate
Settings toggle Log Rotate
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
Requiredenable
Requiredboolean
Successful response
settings.haveActivateRequests
Successful response
settings.toggleRequests
Settings toggle Requests
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
Requiredenable
Requiredboolean
Successful response
settings.isCloud
Successful response
settings.health
Successful response