Skip to main content
POST
Report liveness, receive assignment

Authorizations

Authorization
string
header
required

The opaque agt_r token minted when the runner enrols (POST /v1/runners)

Body

application/json

POST /v1/runners/me/heartbeats request.

The capability report rides the first beat and any beat where the probe result changed. Both fields default to absent so an older runner's empty body still parses.

capability_report
null | object

What this host can enforce, when the probe result is being reported.

selftest
null | object

A verdict produced since the last beat, by request or by startup probe.

Response

OK

POST /v1/runners/me/heartbeats reply.

Carries the current assignment on EVERY beat, so a dashboard change reaches the host within one interval. A null assignment means a row predating the policy columns: the runner then fails closed and refuses to lease.

degraded
boolean
required

Whether the row reads degraded.

selftest_requested
boolean
required

An operator asked this runner to self-test. Rides the beat like the assignment does — one interval, no second endpoint, no host visit.

status
enum<string>
required

Whether to keep working, drain, or stop.

Available options:
ok,
drain,
stop
assigned_policy
null | object

The runner's current assignment.

degraded_reason
string | null

Why it reads degraded.