Admiral
Agents

List agents

GET
/api/v1/agents

Scope: agent:read

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

filter?filter

Filter expression to narrow results. Uses the Admiral filter DSL (see the API documentation for the full operator and predicate reference).

Filterable fields:

  • kind: filter by agent kind (TERRAFORM, KUBERNETES).
  • name: filter by agent name.
  • health_status: filter by health status.
  • labels.key: filter by label key.

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

Lengthlength <= 1024
page_size?page_size

Maximum number of agents to return per page. Defaults to 50 when omitted or 0; must not exceed 100.

Formatint32
Range0 <= value <= 100
page_token?page_token

Opaque pagination token from a previous response.

Response Body

application/json

curl -X GET "https://api.admiral.io/api/v1/agents"
{  "agents": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "AGENT_KIND_UNSPECIFIED",      "name": "string",      "description": "string",      "labels": {        "property1": "string",        "property2": "string"      },      "health_status": "AGENT_HEALTH_STATUS_UNSPECIFIED",      "cluster_uid": "string",      "created_by": {        "id": "string",        "display_name": "string",        "email": "string"      },      "created_at": "2023-01-15T01:30:15.01Z",      "updated_at": "2023-01-15T01:30:15.01Z"    }  ],  "next_page_token": "string"}

List agent jobs GET

Scope: `agent:read`

List agent tokens GET

Scope: `agent:read`