Dokploy
Generated

Settings

POST
/settings.reloadServer

Settings reload Server

/settings.reloadServer

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.reloadTraefik

Settings reload Traefik

/settings.reloadTraefik

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonOptional

serverIdstring

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

Successful response

POST
/settings.toggleDashboard

Settings toggle Dashboard

/settings.toggleDashboard

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

enableDashboardboolean

serverIdstring

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

Successful response

POST
/settings.cleanUnusedImages

Settings clean Unused Images

/settings.cleanUnusedImages

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonOptional

serverIdstring

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

Successful response

POST
/settings.cleanUnusedVolumes

Settings clean Unused Volumes

/settings.cleanUnusedVolumes

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonOptional

serverIdstring

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

Successful response

POST
/settings.cleanStoppedContainers

Settings clean Stopped Containers

/settings.cleanStoppedContainers

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonOptional

serverIdstring

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

Successful response

POST
/settings.cleanDockerBuilder

Settings clean Docker Builder

/settings.cleanDockerBuilder

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonOptional

serverIdstring

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

Successful response

POST
/settings.cleanDockerPrune

Settings clean Docker Prune

/settings.cleanDockerPrune

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonOptional

serverIdstring

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

Successful response

POST
/settings.cleanAll

Settings clean All

/settings.cleanAll

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonOptional

serverIdstring

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

Successful response

POST
/settings.cleanMonitoring

Settings clean Monitoring

/settings.cleanMonitoring

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.saveSSHPrivateKey

Settings save S S H Private Key

/settings.saveSSHPrivateKey

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

sshPrivateKeystring | null

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

Successful response

POST
/settings.assignDomainServer

Settings assign Domain Server

/settings.assignDomainServer

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

host
Required
string | null

certificateTypestring

Default: "none"Value in: "letsencrypt" | "none"

letsEncryptEmailstring | null

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

Successful response

POST
/settings.cleanSSHPrivateKey

Settings clean S S H Private Key

/settings.cleanSSHPrivateKey

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.updateDockerCleanup

Settings update Docker Cleanup

/settings.updateDockerCleanup

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

enableDockerCleanup
Required
boolean

serverIdstring

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

Successful response

GET
/settings.readTraefikConfig

Settings read Traefik Config

/settings.readTraefikConfig

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.updateTraefikConfig

Settings update Traefik Config

/settings.updateTraefikConfig

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

traefikConfig
Required
string

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

Successful response

GET
/settings.readWebServerTraefikConfig

Settings read Web Server Traefik Config

/settings.readWebServerTraefikConfig

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.updateWebServerTraefikConfig

Settings update Web Server Traefik Config

/settings.updateWebServerTraefikConfig

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

traefikConfig
Required
string

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

Successful response

GET
/settings.readMiddlewareTraefikConfig

Settings read Middleware Traefik Config

/settings.readMiddlewareTraefikConfig

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.updateMiddlewareTraefikConfig

Settings update Middleware Traefik Config

/settings.updateMiddlewareTraefikConfig

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

traefikConfig
Required
string

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

Successful response

POST
/settings.checkAndUpdateImage

Settings check And Update Image

/settings.checkAndUpdateImage

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.updateServer

Settings update Server

/settings.updateServer

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

GET
/settings.getDokployVersion

Settings get Dokploy Version

/settings.getDokployVersion

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

GET
/settings.readDirectories

Settings read Directories

/settings.readDirectories

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

serverIdstring

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

Successful response

POST
/settings.updateTraefikFile

Settings update Traefik File

/settings.updateTraefikFile

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

path
Required
string

Minimum length: 1

traefikConfig
Required
string

Minimum length: 1

serverIdstring

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

Successful response

GET
/settings.readTraefikFile

Settings read Traefik File

/settings.readTraefikFile

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

path
Required
string

Minimum length: 1

serverIdstring

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

Successful response

GET
/settings.getIp

Settings get Ip

/settings.getIp

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

GET
/settings.getOpenApiDocument

Settings get Open Api Document

/settings.getOpenApiDocument

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

GET
/settings.readTraefikEnv

Settings read Traefik Env

/settings.readTraefikEnv

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

serverIdstring

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

Successful response

POST
/settings.writeTraefikEnv

Settings write Traefik Env

/settings.writeTraefikEnv

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

env
Required
string

serverIdstring

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

Successful response

GET
/settings.haveTraefikDashboardPortEnabled

Settings have Traefik Dashboard Port Enabled

/settings.haveTraefikDashboardPortEnabled

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

serverIdstring

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

Successful response

GET
/settings.readStats

Settings read Stats

/settings.readStats

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

GET
/settings.getLogRotateStatus

Settings get Log Rotate Status

/settings.getLogRotateStatus

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.toggleLogRotate

Settings toggle Log Rotate

/settings.toggleLogRotate

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

enable
Required
boolean

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

Successful response

GET
/settings.haveActivateRequests

Settings have Activate Requests

/settings.haveActivateRequests

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/settings.toggleRequests

Settings toggle Requests

/settings.toggleRequests

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

enable
Required
boolean

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

Successful response

GET
/settings.isCloud

Settings is Cloud

/settings.isCloud

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

GET
/settings.health

Settings health

/settings.health

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response