Settings
settings.reloadServerSuccessful response
settings.reloadTraefikSettings reload Traefik
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonOptionalserverIdstring
Successful response
settings.toggleDashboardSettings toggle Dashboard
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredenableDashboardboolean
serverIdstring
Successful response
settings.cleanUnusedImagesSettings clean Unused Images
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonOptionalserverIdstring
Successful response
settings.cleanUnusedVolumesSettings clean Unused Volumes
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonOptionalserverIdstring
Successful response
settings.cleanStoppedContainersSettings clean Stopped Containers
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonOptionalserverIdstring
Successful response
settings.cleanDockerBuilderSettings clean Docker Builder
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonOptionalserverIdstring
Successful response
settings.cleanDockerPruneSettings clean Docker Prune
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonOptionalserverIdstring
Successful response
settings.cleanAllSettings clean All
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonOptionalserverIdstring
Successful response
settings.cleanMonitoringSuccessful response
settings.saveSSHPrivateKeySettings save S S H Private Key
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredsshPrivateKeystring | null
Successful response
settings.assignDomainServerSettings assign Domain Server
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredhostRequiredstring | null
certificateTypestring
"none"Value in: "letsencrypt" | "none"letsEncryptEmailstring | null
Successful response
settings.cleanSSHPrivateKeySuccessful response
settings.updateDockerCleanupSettings update Docker Cleanup
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredenableDockerCleanupRequiredboolean
serverIdstring
Successful response
settings.readTraefikConfigSuccessful response
settings.updateTraefikConfigSettings update Traefik Config
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredtraefikConfigRequiredstring
1Successful response
settings.readWebServerTraefikConfigSuccessful response
settings.updateWebServerTraefikConfigSettings update Web Server Traefik Config
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredtraefikConfigRequiredstring
1Successful response
settings.readMiddlewareTraefikConfigSuccessful response
settings.updateMiddlewareTraefikConfigSettings update Middleware Traefik Config
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredtraefikConfigRequiredstring
1Successful response
settings.checkAndUpdateImageSuccessful response
settings.updateServerSuccessful response
settings.getDokployVersionSuccessful response
settings.readDirectoriesSettings read Directories
Authorization
AuthorizationRequiredBearer <token>
In: header
Query Parameters
serverIdstring
Successful response
settings.updateTraefikFileSettings update Traefik File
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredpathRequiredstring
1traefikConfigRequiredstring
1serverIdstring
Successful response
settings.readTraefikFileSettings read Traefik File
Authorization
AuthorizationRequiredBearer <token>
In: header
Query Parameters
pathRequiredstring
1serverIdstring
Successful response
settings.getIpSuccessful response
settings.getOpenApiDocumentSuccessful response
settings.readTraefikEnvSettings read Traefik Env
Authorization
AuthorizationRequiredBearer <token>
In: header
Query Parameters
serverIdstring
Successful response
settings.writeTraefikEnvSettings write Traefik Env
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredenvRequiredstring
serverIdstring
Successful response
settings.haveTraefikDashboardPortEnabledSettings have Traefik Dashboard Port Enabled
Authorization
AuthorizationRequiredBearer <token>
In: header
Query Parameters
serverIdstring
Successful response
settings.readStatsSuccessful response
settings.getLogRotateStatusSuccessful response
settings.toggleLogRotateSettings toggle Log Rotate
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredenableRequiredboolean
Successful response
settings.haveActivateRequestsSuccessful response
settings.toggleRequestsSettings toggle Requests
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredenableRequiredboolean
Successful response
settings.isCloudSuccessful response
settings.healthSuccessful response