Sign in
Nodes

Receive a heartbeat from a worker node

Changed on
post/internal/nodes/{node_id}/heartbeat

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/internal/nodes/{node_id}/heartbeat
  • Auth: none declared

Path parameters

node_idinteger required

Node ID

Request body

architecturestring nullable

Container platform of this node's Docker daemon (linux/amd64, linux/arm64), read from docker info by the agent. Absent from pre-multi-arch agents; the stored value is then left untouched.

capacityunknown
docker_socket_projectsstring[] nullable

Project slugs this node grants host Docker access to (ADR 045), read by the agent from its own TEMPS_DOCKER_SOCKET_PROJECTS.

Advisory only: it tells the scheduler where a granted project may be placed. It can never cause a socket to be mounted — that decision is made by the executing process against its own environment. None from a pre-ADR-045 agent leaves the stored value untouched; an empty array clears it.

labelsunknown

Response

Heartbeat received

messagestring required
statusstring required

Changes

  • 4b228ebed583Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • info

      removed the non-success response with the status