Sign in

v1

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-104136109.1 KB
workers

Heartbeat worker

Create or update worker registry state for a worker

post/workers/{workerID}/heartbeat

Path parameters

workerIDstring required

Worker ID

Request body

capabilitiesstring[]
capacityobject
hostnamestring
providersstring[]
statusstring

Example request

{
  "hostname": "stacyvm-host-1",
  "status": "online"
}

Response

OK

capabilitiesstring[]
capacityobject
created_atstring
hostnamestring
idstring
last_heartbeatstring
providersstring[]
staleboolean
statusstring
updated_atstring

Example response

{
  "created_at": "2026-05-09T10:00:00Z",
  "hostname": "stacyvm-host-1",
  "id": "worker-local",
  "last_heartbeat": "2026-05-09T10:30:00Z",
  "status": "online",
  "updated_at": "2026-05-09T10:30:00Z"
}