Dokploy

Swarm

Swarm get Nodes

GET
/swarm.getNodes

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/swarm.getNodes"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Swarm get Node Info

GET
/swarm.getNodeInfo

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

nodeId*string
serverId?string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/swarm.getNodeInfo?nodeId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Swarm get Node Apps

GET
/swarm.getNodeApps

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/swarm.getNodeApps"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}