Send runner heartbeat
The runner is identified by the service access token -- the server resolves the runner from the SAT's binding. No runner_id is required in the request.
This endpoint is runner-facing and restricted to service access tokens.
Scope: runner:exec | Token types: sat
Authorization
bearerAuth Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer adm_pat_...
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://admiral.example.com/api/v1/runner/heartbeat" \ -H "Content-Type: application/json" \ -d '{ "status": {} }'{ "ack": true, "next_heartbeat_seconds": 0}Retrieve a job bundle GET
The bundle contains everything the runner needs to execute the Terraform operation: rendered .tf files, resolved variables, provider configuration, backend configuration, and the required Terraform version. This endpoint is runner-facing and restricted to service access tokens. Scope: `runner:exec` | Token types: `sat`
Report job result POST
This endpoint is runner-facing and restricted to service access tokens. Scope: `runner:exec` | Token types: `sat`