settings
POST/settings.reloadServer
settings-reloadServer
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.reloadTraefik
settings-reloadTraefik
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.toggleDashboard
settings-toggleDashboard
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
enableDashboard
boolean
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanUnusedImages
settings-cleanUnusedImages
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanUnusedVolumes
settings-cleanUnusedVolumes
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanStoppedContainers
settings-cleanStoppedContainers
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanDockerBuilder
settings-cleanDockerBuilder
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanDockerPrune
settings-cleanDockerPrune
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanAll
settings-cleanAll
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanMonitoring
settings-cleanMonitoring
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.saveSSHPrivateKey
settings-saveSSHPrivateKey
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
sshPrivateKey
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.assignDomainServer
settings-assignDomainServer
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
letsEncryptEmail
Requiredstring | null
host
Requiredstring | null
certificateType
string
Default: "none"
Value in: "letsencrypt" | "none"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanSSHPrivateKey
settings-cleanSSHPrivateKey
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateDockerCleanup
settings-updateDockerCleanup
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
enableDockerCleanup
Requiredboolean
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readTraefikConfig
settings-readTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateTraefikConfig
settings-updateTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
traefikConfig
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readWebServerTraefikConfig
settings-readWebServerTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateWebServerTraefikConfig
settings-updateWebServerTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
traefikConfig
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readMiddlewareTraefikConfig
settings-readMiddlewareTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateMiddlewareTraefikConfig
settings-updateMiddlewareTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
traefikConfig
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.checkAndUpdateImage
settings-checkAndUpdateImage
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateServer
settings-updateServer
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.getDokployVersion
settings-getDokployVersion
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readDirectories
settings-readDirectories
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateTraefikFile
settings-updateTraefikFile
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
path
Requiredstring
Minimum length: 1
traefikConfig
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readTraefikFile
settings-readTraefikFile
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
path
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.getIp
settings-getIp
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.getOpenApiDocument
settings-getOpenApiDocument
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readTraefikEnv
settings-readTraefikEnv
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.writeTraefikEnv
settings-writeTraefikEnv
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
env
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.haveTraefikDashboardPortEnabled
settings-haveTraefikDashboardPortEnabled
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |