Server

POST

/server.create

Server create

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`name`
Required
string

Minimum length: 1

`description`string | null

`ipAddress`
Required
string

`port`
Required
number

`username`
Required
string

`sshKeyId`
Required
string | null

`serverType`
Required
string

Value in: "deploy" | "build"

curl -X POST "https://your-dokploy-instance.com/api/server.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "ipAddress": "string",
    "port": 0,
    "username": "string",
    "sshKeyId": "string",
    "serverType": "deploy"
  }'

Successful response

{}

GET

/server.one

Server one

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`
Required
string

Minimum length: 1

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

Successful response

{}

GET

/server.getDefaultCommand

Server get Default Command

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`
Required
string

Minimum length: 1

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

Successful response

{}

GET

/server.all

Server all

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

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

Successful response

{}

GET

/server.count

Server count

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

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

Successful response

{}

GET

/server.withSSHKey

Server with S S H Key

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

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

Successful response

{}

GET

/server.buildServers

Server build Servers

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

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

Successful response

{}

POST

/server.setup

Server setup

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`serverId`
Required
string

Minimum length: 1

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

Successful response

{}

GET

/server.validate

Server validate

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`
Required
string

Minimum length: 1

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

Successful response

{}

GET

/server.security

Server security

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`serverId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/server.setupMonitoring

Server setup Monitoring

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`serverId`
Required
string

Minimum length: 1

`metricsConfig`
Required
object

curl -X POST "https://your-dokploy-instance.com/api/server.setupMonitoring" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "serverId": "string",
    "metricsConfig": {
      "server": {
        "refreshRate": 2,
        "port": 1,
        "token": "string",
        "urlCallback": "http://example.com",
        "retentionDays": 1,
        "cronJob": "string",
        "thresholds": {
          "cpu": 0,
          "memory": 0
        }
      },
      "containers": {
        "refreshRate": 2,
        "services": {
          "include": [
            "string"
          ],
          "exclude": [
            "string"
          ]
        }
      }
    }
  }'

Successful response

{}

POST

/server.remove

Server remove

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`serverId`
Required
string

Minimum length: 1

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

Successful response

{}

POST

/server.update

Server update

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`name`
Required
string

Minimum length: 1

`description`string | null

`serverId`
Required
string

Minimum length: 1

`ipAddress`
Required
string

`port`
Required
number

`username`
Required
string

`sshKeyId`
Required
string | null

`serverType`
Required
string

Value in: "deploy" | "build"

`command`string

curl -X POST "https://your-dokploy-instance.com/api/server.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "serverId": "string",
    "ipAddress": "string",
    "port": 0,
    "username": "string",
    "sshKeyId": "string",
    "serverType": "deploy",
    "command": "string"
  }'

Successful response

{}

GET

/server.publicIp

Server public Ip

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

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

Successful response

{}

GET

/server.getServerTime

Server get Server Time

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

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

Successful response

{}

GET

/server.getServerMetrics

Server get Server Metrics

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`url`
Required
string

`token`
Required
string

`dataPoints`
Required
string

curl -X GET "https://your-dokploy-instance.com/api/server.getServerMetrics?url=string&token=string&dataPoints=string" \
  -H "Authorization: <token>"

Successful response

{}

Body

Authorization<token>

nameRequiredstring

descriptionstring | null

ipAddressRequiredstring

portRequirednumber

usernameRequiredstring

sshKeyIdRequiredstring | null

serverTypeRequiredstring

Response

TypeScript

Query

Authorization<token>

serverIdRequiredstring

Response

TypeScript

Query

Authorization<token>

serverIdRequiredstring

Response

TypeScript

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

Body

Authorization<token>

serverIdRequiredstring

Response

TypeScript

Query

Authorization<token>

serverIdRequiredstring

Response

TypeScript

Query

Authorization<token>

serverIdRequiredstring

Response

TypeScript

Body

Authorization<token>

serverIdRequiredstring

metricsConfigRequiredobject

Attributes

Response

TypeScript

Body

Authorization<token>

serverIdRequiredstring

Response

TypeScript

Body

Authorization<token>

nameRequiredstring

descriptionstring | null

serverIdRequiredstring

ipAddressRequiredstring

portRequirednumber

usernameRequiredstring

sshKeyIdRequiredstring | null

serverTypeRequiredstring

commandstring

Response

TypeScript

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

`Authorization`<token>

`name`
Required
string

`description`string | null

`ipAddress`
Required
string

`port`
Required
number

`username`
Required
string

`sshKeyId`
Required
string | null

`serverType`
Required
string

`Authorization`<token>

`serverId`
Required
string

`Authorization`<token>

`serverId`
Required
string

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`serverId`
Required
string

`Authorization`<token>

`serverId`
Required
string

`Authorization`<token>

`serverId`
Required
string

`Authorization`<token>

`serverId`
Required
string

`metricsConfig`
Required
object

`Authorization`<token>

`serverId`
Required
string

`Authorization`<token>

`name`
Required
string

`description`string | null

`serverId`
Required
string

`ipAddress`
Required
string

`port`
Required
number

`username`
Required
string

`sshKeyId`
Required
string | null

`serverType`
Required
string

`command`string

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`url`
Required
string

`token`
Required
string

`dataPoints`
Required
string