Dokploy

settings

POST/settings.reloadServer

settings-reloadServer

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.reloadServer"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.reloadTraefik

settings-reloadTraefik

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.reloadTraefik"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.toggleDashboard

settings-toggleDashboard

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

enableDashboardboolean

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.toggleDashboard" \
  -d '{
  "enableDashboard": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanUnusedImages

settings-cleanUnusedImages

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.cleanUnusedImages"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanUnusedVolumes

settings-cleanUnusedVolumes

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.cleanUnusedVolumes"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanStoppedContainers

settings-cleanStoppedContainers

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.cleanStoppedContainers"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanDockerBuilder

settings-cleanDockerBuilder

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.cleanDockerBuilder"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanDockerPrune

settings-cleanDockerPrune

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.cleanDockerPrune"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanAll

settings-cleanAll

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.cleanAll"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanMonitoring

settings-cleanMonitoring

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.cleanMonitoring"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.saveSSHPrivateKey

settings-saveSSHPrivateKey

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

sshPrivateKeystring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.saveSSHPrivateKey" \
  -d '{
  "sshPrivateKey": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.assignDomainServer

settings-assignDomainServer

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

letsEncryptEmail
Required
string | null

host
Required
string | null

certificateTypestring

Default: "none"Value in: "letsencrypt" | "none"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.assignDomainServer" \
  -d '{
  "letsEncryptEmail": "string",
  "host": "string",
  "certificateType": "letsencrypt"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanSSHPrivateKey

settings-cleanSSHPrivateKey

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.cleanSSHPrivateKey"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateDockerCleanup

settings-updateDockerCleanup

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

enableDockerCleanup
Required
boolean

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.updateDockerCleanup" \
  -d '{
  "enableDockerCleanup": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readTraefikConfig

settings-readTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.readTraefikConfig"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateTraefikConfig

settings-updateTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

traefikConfig
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.updateTraefikConfig" \
  -d '{
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readWebServerTraefikConfig

settings-readWebServerTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.readWebServerTraefikConfig"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateWebServerTraefikConfig

settings-updateWebServerTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

traefikConfig
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.updateWebServerTraefikConfig" \
  -d '{
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readMiddlewareTraefikConfig

settings-readMiddlewareTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.readMiddlewareTraefikConfig"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateMiddlewareTraefikConfig

settings-updateMiddlewareTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

traefikConfig
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.updateMiddlewareTraefikConfig" \
  -d '{
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.checkAndUpdateImage

settings-checkAndUpdateImage

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.checkAndUpdateImage"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateServer

settings-updateServer

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.updateServer"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.getDokployVersion

settings-getDokployVersion

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.getDokployVersion"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readDirectories

settings-readDirectories

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.readDirectories"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateTraefikFile

settings-updateTraefikFile

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

path
Required
string

Minimum length: 1

traefikConfig
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.updateTraefikFile" \
  -d '{
  "path": "string",
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readTraefikFile

settings-readTraefikFile

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

path
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.readTraefikFile?path=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.getIp

settings-getIp

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.getIp"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.getOpenApiDocument

settings-getOpenApiDocument

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.getOpenApiDocument"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readTraefikEnv

settings-readTraefikEnv

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.readTraefikEnv"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.writeTraefikEnv

settings-writeTraefikEnv

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

env
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/settings.writeTraefikEnv" \
  -d '{
  "env": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.haveTraefikDashboardPortEnabled

settings-haveTraefikDashboardPortEnabled

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/settings.haveTraefikDashboardPortEnabled"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Previous

security

Next

sshKey

On this page

settings-reloadServerAuthorizationsettings-reloadTraefikAuthorizationsettings-toggleDashboardAuthorizationRequest Bodysettings-cleanUnusedImagesAuthorizationsettings-cleanUnusedVolumesAuthorizationsettings-cleanStoppedContainersAuthorizationsettings-cleanDockerBuilderAuthorizationsettings-cleanDockerPruneAuthorizationsettings-cleanAllAuthorizationsettings-cleanMonitoringAuthorizationsettings-saveSSHPrivateKeyAuthorizationRequest Bodysettings-assignDomainServerAuthorizationRequest Bodysettings-cleanSSHPrivateKeyAuthorizationsettings-updateDockerCleanupAuthorizationRequest Bodysettings-readTraefikConfigAuthorizationsettings-updateTraefikConfigAuthorizationRequest Bodysettings-readWebServerTraefikConfigAuthorizationsettings-updateWebServerTraefikConfigAuthorizationRequest Bodysettings-readMiddlewareTraefikConfigAuthorizationsettings-updateMiddlewareTraefikConfigAuthorizationRequest Bodysettings-checkAndUpdateImageAuthorizationsettings-updateServerAuthorizationsettings-getDokployVersionAuthorizationsettings-readDirectoriesAuthorizationsettings-updateTraefikFileAuthorizationRequest Bodysettings-readTraefikFileAuthorizationQuery Parameterssettings-getIpAuthorizationsettings-getOpenApiDocumentAuthorizationsettings-readTraefikEnvAuthorizationsettings-writeTraefikEnvAuthorizationRequest Bodysettings-haveTraefikDashboardPortEnabledAuthorization