Claim a job
The runner is identified by the service access token -- no runner_id is required.
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.
ClaimJobRequest is sent by the runner to poll for available work. The runner is identified by the SAT's binding -- no runner_id is required.
Response Body
application/json
curl -X POST "https://admiral.example.com/api/v1/runner/jobs/claim" \ -H "Content-Type: application/json" \ -d '{}'{ "job": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "runner_id": "9d0962d6-7c33-45b9-936f-62727b39a370", "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a", "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6", "job_type": "JOB_TYPE_UNSPECIFIED", "status": "JOB_STATUS_UNSPECIFIED", "created_at": "2023-01-15T01:30:15.01Z", "started_at": "2023-01-15T01:30:15.01Z", "completed_at": "2023-01-15T01:30:15.01Z" }}Check service health GET
Healthcheck verifies that the service is running and healthy. Returns an empty response on success. Use this endpoint for load balancer health checks and monitoring systems.
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`