Skip to Content
SeyloDocs
API referenceNodes

Allow or forbid builds on a node

POST
/api/v1/nodes.setCanBuild

Turns builds on this node on or off. Images built anywhere run on every node, so small nodes usually leave this off.

Needs nodes.manage, which owners and admins hold. Available to MCP clients and the assistant.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
nodeId*string

Panel-issued id.

Match^[a-z0-9]{16}$
canBuild*boolean

Response Body

Success.

application/json
  1. response
id*string

Panel-issued id.

Match^[a-z0-9]{16}$
name*string

Lowercase letters, digits, dots and hyphens; unique.

Match^[a-z0-9][a-z0-9.-]*$
Length1 <= length <= 60
location*|null
tags*array<>
status*string|string|string
isPanelNode*boolean
publicIpv4*string|null
publicIpv6*string|null
publicAddress*string|null
wildcardDomain*string|null
agentVersion*string|null
updateAvailable*boolean
canBuild*boolean
canBuildWarning*string|null
maxParallelBuilds*integer
Range1 <= value <= 16
wings*
gamesFirstCpu*boolean
facts*|null
usage*|null
serviceCount*integer
Range0 <= value
health*
lastSeenAt*|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X POST 'https://example.com/api/v1/nodes.setCanBuild' \  -H 'Content-Type: application/json' \  -d '{  "nodeId": "string",  "canBuild": true}'
Example Response
{  "id": "string",  "name": "string",  "location": "string",  "tags": [    "string"  ],  "status": "online",  "isPanelNode": true,  "publicIpv4": "string",  "publicIpv6": "string",  "publicAddress": "string",  "wildcardDomain": "string",  "agentVersion": "string",  "updateAvailable": true,  "canBuild": true,  "canBuildWarning": "string",  "maxParallelBuilds": 1,  "wings": {    "detected": true,    "version": "string",    "sharedProxy": true  },  "gamesFirstCpu": true,  "facts": {    "hostname": "string",    "os": "string",    "kernel": "string",    "arch": "string",    "cpuCores": 0,    "memoryTotalBytes": 0,    "diskTotalBytes": 0,    "diskFreeBytes": 0,    "dockerVersion": "string",    "cgroupVersion": 0,    "bootTime": "2019-08-24T14:15:22Z"  },  "usage": {    "at": "2019-08-24T14:15:22Z",    "cpuPercent": 0,    "memoryUsedBytes": 0,    "memoryTotalBytes": 0,    "diskUsedBytes": 0,    "diskTotalBytes": 0,    "networkRxBytesPerSec": 0,    "networkTxBytesPerSec": 0,    "load1": 0  },  "serviceCount": 0,  "health": {    "checkedAt": "2019-08-24T14:15:22Z",    "worst": "pass"  },  "lastSeenAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Run node health checks POST

Runs the node health checks now (Docker, disk, clock, ports 80 and 443, DNS, proxy, Wings coexistence) and stores the report. Needs `nodes.manage`, which owners and admins hold. Available to MCP clients and the assistant.

Give game servers CPU priority POST

Next to Pelican Wings only: lowers the CPU weight of this panel's services so game servers win when the CPU is busy. Fails with CONFLICT when Wings is not detected. Needs `nodes.manage`, which owners and admins hold. Available to MCP clients and the assistant.