Docs
Sign in

Rename a node, cap its agents or stop it accepting tasks.

PATCH/api/v1/nodes/{id}

Scopeconfig

No query parameters.

Path parameters.

idstringrequired

The machine's id.

Body.

namestring

The machine's name. At least 1 character.

maxAgents0–32

Agents this machine runs at once. 0 takes none.

acceptsTasksboolean

Off: no new agent is started on it.

Response.

200 OK: a Node. The example has placeholder values.

422 validation_failed
The body does not match its schema; each problem is in details.