Settings

POST

/settings.reloadServer

Settings reload Server

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadServer" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.cleanRedis

Settings clean Redis

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanRedis" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.reloadRedis

Settings reload Redis

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadRedis" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.reloadTraefik

Settings reload Traefik

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonOptional

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadTraefik" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string"
  }'

Successful response

{}

POST

/settings.toggleDashboard

Settings toggle Dashboard

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`enableDashboard`boolean

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.toggleDashboard" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enableDashboard": true,
    "serverId": "string"
  }'

Successful response

{}

POST

/settings.cleanUnusedImages

Settings clean Unused Images

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonOptional

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanUnusedImages" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string"
  }'

Successful response

{}

POST

/settings.cleanUnusedVolumes

Settings clean Unused Volumes

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonOptional

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanUnusedVolumes" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string"
  }'

Successful response

{}

POST

/settings.cleanStoppedContainers

Settings clean Stopped Containers

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonOptional

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanStoppedContainers" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string"
  }'

Successful response

{}

POST

/settings.cleanDockerBuilder

Settings clean Docker Builder

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonOptional

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanDockerBuilder" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string"
  }'

Successful response

{}

POST

/settings.cleanDockerPrune

Settings clean Docker Prune

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonOptional

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanDockerPrune" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string"
  }'

Successful response

{}

POST

/settings.cleanAll

Settings clean All

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonOptional

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanAll" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string"
  }'

Successful response

{}

POST

/settings.cleanMonitoring

Settings clean Monitoring

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanMonitoring" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.saveSSHPrivateKey

Settings save S S H Private Key

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`sshPrivateKey`
Required
string | null

curl -X POST "https://your-dokploy-instance.com/api/settings.saveSSHPrivateKey" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "sshPrivateKey": "string"
  }'

Successful response

{}

POST

/settings.assignDomainServer

Settings assign Domain Server

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`host`
Required
string | null

`certificateType`
Required
string

Value in: "letsencrypt" | "none" | "custom"

`letsEncryptEmail`string | null

`https`boolean

curl -X POST "https://your-dokploy-instance.com/api/settings.assignDomainServer" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "string",
    "certificateType": "letsencrypt",
    "letsEncryptEmail": "string",
    "https": true
  }'

Successful response

{}

POST

/settings.cleanSSHPrivateKey

Settings clean S S H Private Key

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanSSHPrivateKey" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.updateDockerCleanup

Settings update Docker Cleanup

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`enableDockerCleanup`
Required
boolean

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.updateDockerCleanup" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enableDockerCleanup": true,
    "serverId": "string"
  }'

Successful response

{}

GET

/settings.readTraefikConfig

Settings read Traefik Config

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikConfig" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.updateTraefikConfig

Settings update Traefik Config

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`traefikConfig`
Required
string

Minimum length: 1

curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikConfig" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "traefikConfig": "string"
  }'

Successful response

{}

GET

/settings.readWebServerTraefikConfig

Settings read Web Server Traefik Config

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.readWebServerTraefikConfig" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.updateWebServerTraefikConfig

Settings update Web Server Traefik Config

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`traefikConfig`
Required
string

Minimum length: 1

curl -X POST "https://your-dokploy-instance.com/api/settings.updateWebServerTraefikConfig" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "traefikConfig": "string"
  }'

Successful response

{}

GET

/settings.readMiddlewareTraefikConfig

Settings read Middleware Traefik Config

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.readMiddlewareTraefikConfig" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.updateMiddlewareTraefikConfig

Settings update Middleware Traefik Config

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`traefikConfig`
Required
string

Minimum length: 1

curl -X POST "https://your-dokploy-instance.com/api/settings.updateMiddlewareTraefikConfig" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "traefikConfig": "string"
  }'

Successful response

{}

POST

/settings.getUpdateData

Settings get Update Data

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X POST "https://your-dokploy-instance.com/api/settings.getUpdateData" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.updateServer

Settings update Server

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X POST "https://your-dokploy-instance.com/api/settings.updateServer" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.getDokployVersion

Settings get Dokploy Version

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployVersion" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.getReleaseTag

Settings get Release Tag

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.getReleaseTag" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.readDirectories

Settings read Directories

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`string

curl -X GET "https://your-dokploy-instance.com/api/settings.readDirectories?serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.updateTraefikFile

Settings update Traefik File

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`path`
Required
string

Minimum length: 1

`traefikConfig`
Required
string

Minimum length: 1

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikFile" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "string",
    "traefikConfig": "string",
    "serverId": "string"
  }'

Successful response

{}

GET

/settings.readTraefikFile

Settings read Traefik File

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`path`
Required
string

Minimum length: 1

`serverId`string

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikFile?path=string&serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.getIp

Settings get Ip

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.getIp" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.getOpenApiDocument

Settings get Open Api Document

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.getOpenApiDocument" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.readTraefikEnv

Settings read Traefik Env

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`string

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikEnv?serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.writeTraefikEnv

Settings write Traefik Env

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`env`
Required
string

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.writeTraefikEnv" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "env": "string",
    "serverId": "string"
  }'

Successful response

{}

GET

/settings.haveTraefikDashboardPortEnabled

Settings have Traefik Dashboard Port Enabled

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`string

curl -X GET "https://your-dokploy-instance.com/api/settings.haveTraefikDashboardPortEnabled?serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.haveActivateRequests

Settings have Activate Requests

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.haveActivateRequests" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.toggleRequests

Settings toggle Requests

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`enable`
Required
boolean

curl -X POST "https://your-dokploy-instance.com/api/settings.toggleRequests" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enable": true
  }'

Successful response

{}

GET

/settings.isCloud

Settings is Cloud

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.isCloud" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.isUserSubscribed

Settings is User Subscribed

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.isUserSubscribed" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.health

Settings health

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.health" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.setupGPU

Settings setup G P U

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`serverId`string

curl -X POST "https://your-dokploy-instance.com/api/settings.setupGPU" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string"
  }'

Successful response

{}

GET

/settings.checkGPUStatus

Settings check G P U Status

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`string

curl -X GET "https://your-dokploy-instance.com/api/settings.checkGPUStatus?serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.updateTraefikPorts

Settings update Traefik Ports

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`serverId`string

`additionalPorts`
Required
array<object>

curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikPorts" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string",
    "additionalPorts": [
      {
        "targetPort": 0,
        "publishedPort": 0,
        "protocol": "tcp"
      }
    ]
  }'

Successful response

{}

GET

/settings.getTraefikPorts

Settings get Traefik Ports

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`string

curl -X GET "https://your-dokploy-instance.com/api/settings.getTraefikPorts?serverId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/settings.updateLogCleanup

Settings update Log Cleanup

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`cronExpression`
Required
string | null

curl -X POST "https://your-dokploy-instance.com/api/settings.updateLogCleanup" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "cronExpression": "string"
  }'

Successful response

{}

GET

/settings.getLogCleanupStatus

Settings get Log Cleanup Status

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.getLogCleanupStatus" \
  -H "Authorization: <token>"

Successful response

{}

GET

/settings.getDokployCloudIps

Settings get Dokploy Cloud Ips

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployCloudIps" \
  -H "Authorization: <token>"

Successful response

{}

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

Body

Authorization<token>

serverIdstring

Response

TypeScript

Body

Authorization<token>

enableDashboardboolean

serverIdstring

Response

TypeScript

Body

Authorization<token>

serverIdstring

Response

TypeScript

Body

Authorization<token>

serverIdstring

Response

TypeScript

Body

Authorization<token>

serverIdstring

Response

TypeScript

Body

Authorization<token>

serverIdstring

Response

TypeScript

Body

Authorization<token>

serverIdstring

Response

TypeScript

Body

Authorization<token>

serverIdstring

Response

TypeScript

Authorization<token>

Response

TypeScript

Body

Authorization<token>

sshPrivateKeyRequiredstring | null

Response

TypeScript

Body

Authorization<token>

hostRequiredstring | null

certificateTypeRequiredstring

letsEncryptEmailstring | null

httpsboolean

Response

TypeScript

Authorization<token>

Response

TypeScript

Body

Authorization<token>

enableDockerCleanupRequiredboolean

serverIdstring

Response

TypeScript

Authorization<token>

Response

TypeScript

Body

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`serverId`string

`Authorization`<token>

`enableDashboard`boolean

`serverId`string

`Authorization`<token>

`serverId`string

`Authorization`<token>

`serverId`string

`Authorization`<token>

`serverId`string

`Authorization`<token>

`serverId`string

`Authorization`<token>

`serverId`string

`Authorization`<token>

`serverId`string

`Authorization`<token>

`Authorization`<token>

`sshPrivateKey`
Required
string | null

`Authorization`<token>

`host`
Required
string | null

`certificateType`
Required
string

`letsEncryptEmail`string | null

`https`boolean

`Authorization`<token>

`Authorization`<token>

`enableDockerCleanup`
Required
boolean

`serverId`string

`Authorization`<token>

`Authorization`<token>

`traefikConfig`
Required
string

`Authorization`<token>

`Authorization`<token>

`traefikConfig`
Required
string

`Authorization`<token>