Admiral
Runners

List runners

GET
/api/v1/runners

Scope: runner:read

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer adm_pat_...

In: header

Query Parameters

filter?filter

Filter expression to narrow results. Uses the Admiral filter DSL.

Syntax: field['name'] = 'value' with AND/OR/NOT, comparison operators (=, !=, <, >, <=, >=, ~=), and predicates (IN, BETWEEN, CONTAINS, STARTS_WITH, ENDS_WITH, IS NULL, EXISTS).

Filterable fields:

  • name -- filter by runner name.
  • kind -- filter by runner kind (TERRAFORM, WORKFLOW).
  • health_status -- filter by health status.
  • labels.key -- filter by label key.

Example: field['kind'] = 'TERRAFORM' AND field['health_status'] = 'HEALTHY'

Lengthlength <= 1024
page_size?page_size

Maximum number of runners to return per page.

Formatint32
Range0 <= value <= 100
page_token?page_token

Opaque pagination token from a previous response.

Response Body

application/json

curl -X GET "https://admiral.example.com/api/v1/runners"
{  "runners": [    {      "id": "b2c3d4e5-6789-0abc-def1-234567890abc",      "name": "prod-terraform-runner",      "description": "Terraform runner for production AWS infrastructure provisioning.",      "kind": "RUNNER_KIND_TERRAFORM",      "labels": {        "cloud": "aws",        "team": "platform"      },      "health_status": "RUNNER_HEALTH_STATUS_HEALTHY",      "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",      "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",      "created_at": "2025-07-15T10:00:00Z",      "updated_at": "2025-11-18T08:30:00Z"    }  ],  "next_page_token": "string"}

List runner jobs GET

Scope: `runner:read`

List runner tokens GET

Scope: `runner:read`