Renew a job lease

POST/api/runners/leases/{lease_id}/heartbeat

heartbeatLease

Requires authentication using a bearer token — see tokens and scopes.

curl

curl -X POST 'https://neosource.dev/api/runners/leases/LEASE_ID/heartbeat' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN'

fetch

fetch("https://neosource.dev/api/runners/leases/LEASE_ID/heartbeat", {
  method: "POST",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
  },
});

Path parameters

lease_idrequired: string

Responses

200Renewed lease

application/json

HeartbeatResponse

object

cancel_requested: boolean
The cancel wire: `true` once the job was moved to `cancelling` server-side (a run/job cancel). The agent aborts the job, deletes its pod, and reports the job `cancelled` via `complete` instead of running to completion. Defaulted for wire-compat with older agents.
expires_atrequired: integerint64
lease_idrequired: string

Standard errors

Bodies documented once for the whole API — see standard errors.

400Bad Request — one of: invalid_input
401Authentication required
403Forbidden — one of: forbidden
404Not Found — one of: not_found
409Conflict — one of: conflict
429Rate limited — retry after the `Retry-After` header
500Internal server error
503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
504Gateway timeout — the request exceeded the server's handling budget