Skip to content

Fleet ​

GET /api/activity/overview ​

Recent server and node activity for the administrator overview (requires servers.view; excludes audit details)

  • Access: Administrator

GET /api/jobs ​

Recent jobs

  • Access: Signed-in user (browser session); also reachable with an API token that has the read scope

GET /api/nodes ​

List nodes

  • Access: Administrator

POST /api/nodes ​

Register a node

  • Access: Administrator
  • Body: name, location, memoryMb, cpuPercent, diskMb, headroomMb?

PATCH /api/nodes/{id} ​

Edit a node

  • Access: Administrator
  • Path parameters: id

DELETE /api/nodes/{id} ​

Remove an empty node

  • Access: Administrator
  • Path parameters: id

POST /api/nodes/{id}/enrollment ​

Create a one-time enrollment token for a node

  • Access: Administrator
  • Path parameters: id

POST /api/nodes/{id}/evacuate ​

Move every server off a node

  • Access: Administrator
  • Path parameters: id

PATCH /api/nodes/{id}/virtualization ​

Allow or disallow new VM placement on a host after checking agent prerequisites

  • Access: Administrator
  • Path parameters: id
  • Body: enabled:boolean

GET /api/overview ​

Counts of nodes, servers and capacity

  • Access: Administrator

Released under the AGPL-3.0-only license.