Dokploy

Settings

POST
/settings.reloadServer

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadServer"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanRedis

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanRedis"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.reloadRedis

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadRedis"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.reloadTraefik

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadTraefik" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.toggleDashboard

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

enableDashboard?boolean
serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.toggleDashboard" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanUnusedImages

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanUnusedImages" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanUnusedVolumes

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanUnusedVolumes" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanStoppedContainers

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanStoppedContainers" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanDockerBuilder

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanDockerBuilder" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanDockerPrune

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanDockerPrune" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanAll

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanAll" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanMonitoring

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanMonitoring"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.saveSSHPrivateKey

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

sshPrivateKey*string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.saveSSHPrivateKey" \  -H "Content-Type: application/json" \  -d '{    "sshPrivateKey": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.assignDomainServer

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

host*string|null
certificateType*string
Value in"letsencrypt" | "none" | "custom"
letsEncryptEmail?string|null
https?boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.assignDomainServer" \  -H "Content-Type: application/json" \  -d '{    "host": "string",    "certificateType": "letsencrypt"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.cleanSSHPrivateKey

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanSSHPrivateKey"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.updateDockerCleanup

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

enableDockerCleanup*boolean
serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.updateDockerCleanup" \  -H "Content-Type: application/json" \  -d '{    "enableDockerCleanup": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.readTraefikConfig

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikConfig"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.updateTraefikConfig

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

traefikConfig*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikConfig" \  -H "Content-Type: application/json" \  -d '{    "traefikConfig": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.readWebServerTraefikConfig

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.readWebServerTraefikConfig"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.updateWebServerTraefikConfig

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

traefikConfig*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.updateWebServerTraefikConfig" \  -H "Content-Type: application/json" \  -d '{    "traefikConfig": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.readMiddlewareTraefikConfig

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.readMiddlewareTraefikConfig"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.updateMiddlewareTraefikConfig

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

traefikConfig*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.updateMiddlewareTraefikConfig" \  -H "Content-Type: application/json" \  -d '{    "traefikConfig": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.getUpdateData

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.getUpdateData"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.updateServer

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.updateServer"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.getDokployVersion

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployVersion"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.getReleaseTag

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.getReleaseTag"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.readDirectories

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

serverId?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.readDirectories"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.updateTraefikFile

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

path*string
Length1 <= length
traefikConfig*string
Length1 <= length
serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikFile" \  -H "Content-Type: application/json" \  -d '{    "path": "string",    "traefikConfig": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.readTraefikFile

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

path*string
Length1 <= length
serverId?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikFile?path=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.getIp

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.getIp"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.getOpenApiDocument

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.getOpenApiDocument"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.readTraefikEnv

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

serverId?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikEnv"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.writeTraefikEnv

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

env*string
serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.writeTraefikEnv" \  -H "Content-Type: application/json" \  -d '{    "env": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.haveTraefikDashboardPortEnabled

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

serverId?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.haveTraefikDashboardPortEnabled"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.haveActivateRequests

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.haveActivateRequests"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.toggleRequests

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

enable*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.toggleRequests" \  -H "Content-Type: application/json" \  -d '{    "enable": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.isCloud

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.isCloud"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.isUserSubscribed

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.isUserSubscribed"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.health

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.health"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.setupGPU

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.setupGPU" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.checkGPUStatus

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

serverId?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.checkGPUStatus"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.updateTraefikPorts

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverId?string
additionalPorts*
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikPorts" \  -H "Content-Type: application/json" \  -d '{    "additionalPorts": [      {        "targetPort": 0,        "publishedPort": 0,        "protocol": "tcp"      }    ]  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.getTraefikPorts

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

serverId?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.getTraefikPorts"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/settings.updateLogCleanup

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

cronExpression*string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/settings.updateLogCleanup" \  -H "Content-Type: application/json" \  -d '{    "cronExpression": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.getLogCleanupStatus

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.getLogCleanupStatus"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/settings.getDokployCloudIps

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployCloudIps"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}