Dokploy

Server

POST
/server.create

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

name*string
Length1 <= length
description?string|null
ipAddress*string
port*number
username*string
sshKeyId*string|null
serverType*string
Value in"deploy" | "build"
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/server.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "ipAddress": "string",    "port": 0,    "username": "string",    "sshKeyId": "string",    "serverType": "deploy"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.one

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

serverId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/server.one?serverId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.getDefaultCommand

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

serverId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/server.getDefaultCommand?serverId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.all

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/server.all"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.count

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/server.count"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.withSSHKey

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/server.withSSHKey"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.buildServers

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/server.buildServers"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/server.setup

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

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

Response Body

application/json

application/json

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

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

serverId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/server.validate?serverId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.security

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

serverId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/server.security?serverId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/server.setupMonitoring

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

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

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/server.setupMonitoring" \  -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": {}      }    }  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/server.remove

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

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

Response Body

application/json

application/json

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

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

name*string
Length1 <= length
description?string|null
serverId*string
Length1 <= length
ipAddress*string
port*number
username*string
sshKeyId*string|null
serverType*string
Value in"deploy" | "build"
command?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/server.update" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "serverId": "string",    "ipAddress": "string",    "port": 0,    "username": "string",    "sshKeyId": "string",    "serverType": "deploy"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.publicIp

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/server.publicIp"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.getServerTime

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/server.getServerTime"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/server.getServerMetrics

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

url*string
token*string
dataPoints*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/server.getServerMetrics?url=string&token=string&dataPoints=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Security

Previous Page

Settings

Next Page