Settings

Settings reload Server

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadServer"

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadServer"

{}

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

Settings clean Redis

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanRedis"

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanRedis"

{}

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

Settings reload Redis

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadRedis"

curl -X POST "https://your-dokploy-instance.com/api/settings.reloadRedis"

{}

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

Settings reload Traefik

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`

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

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

{}

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

Settings toggle Dashboard

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`

curl -X POST "https://your-dokploy-instance.com/api/settings.toggleDashboard" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://your-dokploy-instance.com/api/settings.toggleDashboard" \  -H "Content-Type: application/json" \  -d '{}'

{}

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

Settings clean Unused Images

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`

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

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

{}

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

Settings clean Unused Volumes

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`

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

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

{}

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

Settings clean Stopped Containers

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`

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

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

{}

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

Settings clean Docker Builder

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`

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

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

{}

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

Settings clean Docker Prune

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`

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

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

{}

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

Settings clean All

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`

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

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

{}

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

Settings clean Monitoring

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanMonitoring"

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanMonitoring"

{}

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

Settings save S S H Private Key

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`

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

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"
    }
  ]
}

Settings assign Domain Server

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`

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

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"
    }
  ]
}

Settings clean S S H Private Key

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanSSHPrivateKey"

curl -X POST "https://your-dokploy-instance.com/api/settings.cleanSSHPrivateKey"

{}

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

Settings update Docker Cleanup

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`

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

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"
    }
  ]
}

Settings read Traefik Config

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikConfig"

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikConfig"

{}

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

Settings update Traefik Config

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`

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

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"
    }
  ]
}

Settings read Web Server Traefik Config

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.readWebServerTraefikConfig"

curl -X GET "https://your-dokploy-instance.com/api/settings.readWebServerTraefikConfig"

{}

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

Settings update Web Server Traefik Config

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`

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

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"
    }
  ]
}

Settings read Middleware Traefik Config

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.readMiddlewareTraefikConfig"

curl -X GET "https://your-dokploy-instance.com/api/settings.readMiddlewareTraefikConfig"

{}

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

Settings update Middleware Traefik Config

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`

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

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"
    }
  ]
}

Settings get Update Data

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/settings.getUpdateData"

curl -X POST "https://your-dokploy-instance.com/api/settings.getUpdateData"

{}

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

Settings update Server

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/settings.updateServer"

curl -X POST "https://your-dokploy-instance.com/api/settings.updateServer"

{}

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

Settings get Dokploy Version

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployVersion"

curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployVersion"

{}

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

Settings get Release Tag

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.getReleaseTag"

curl -X GET "https://your-dokploy-instance.com/api/settings.getReleaseTag"

{}

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

Settings read Directories

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`

curl -X GET "https://your-dokploy-instance.com/api/settings.readDirectories"

curl -X GET "https://your-dokploy-instance.com/api/settings.readDirectories"

{}

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

Settings update Traefik File

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`

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

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"
    }
  ]
}

Settings read Traefik File

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`

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikFile?path=string"

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikFile?path=string"

{}

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

Settings get Ip

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.getIp"

curl -X GET "https://your-dokploy-instance.com/api/settings.getIp"

{}

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

Settings get Open Api Document

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.getOpenApiDocument"

curl -X GET "https://your-dokploy-instance.com/api/settings.getOpenApiDocument"

{}

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

Settings read Traefik Env

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`

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikEnv"

curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikEnv"

{}

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

Settings write Traefik Env

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`

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

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"
    }
  ]
}

Settings have Traefik Dashboard Port Enabled

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`

curl -X GET "https://your-dokploy-instance.com/api/settings.haveTraefikDashboardPortEnabled"

curl -X GET "https://your-dokploy-instance.com/api/settings.haveTraefikDashboardPortEnabled"

{}

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

Settings have Activate Requests

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.haveActivateRequests"

curl -X GET "https://your-dokploy-instance.com/api/settings.haveActivateRequests"

{}

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

Settings toggle Requests

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`

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

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"
    }
  ]
}

Settings is Cloud

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.isCloud"

curl -X GET "https://your-dokploy-instance.com/api/settings.isCloud"

{}

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

Settings is User Subscribed

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.isUserSubscribed"

curl -X GET "https://your-dokploy-instance.com/api/settings.isUserSubscribed"

{}

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

Settings health

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.health"

curl -X GET "https://your-dokploy-instance.com/api/settings.health"

{}

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

Settings setup G P U

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`

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

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

{}

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

Settings check G P U Status

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`

curl -X GET "https://your-dokploy-instance.com/api/settings.checkGPUStatus"

curl -X GET "https://your-dokploy-instance.com/api/settings.checkGPUStatus"

{}

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

Settings update Traefik Ports

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`

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

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"
    }
  ]
}

Settings get Traefik Ports

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`

curl -X GET "https://your-dokploy-instance.com/api/settings.getTraefikPorts"

curl -X GET "https://your-dokploy-instance.com/api/settings.getTraefikPorts"

{}

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

Settings update Log Cleanup

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`

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

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"
    }
  ]
}

Settings get Log Cleanup Status

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.getLogCleanupStatus"

curl -X GET "https://your-dokploy-instance.com/api/settings.getLogCleanupStatus"

{}

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

Settings get Dokploy Cloud Ips

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployCloudIps"

curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployCloudIps"

{}

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

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`