Admiral
Agents

List agent jobs

GET
/api/v1/agents/{agent_id}/jobs

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

Path Parameters

agent_id*agent_id

The agent whose jobs to list (UUID).

Formatuuid

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:

  • status: filter by job status (PENDING, ASSIGNED, RUNNING, etc.).
  • job_type: filter by job type (PLAN, APPLY, DESTROY_PLAN, DESTROY_APPLY).
  • run_id: jobs for a specific run (UUID).
Lengthlength <= 1024
page_size?page_size

Maximum number of jobs 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/497f6eca-6276-4993-bfeb-53cbbbba6f08/jobs"
{  "jobs": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",      "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a",      "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",      "job_type": "JOB_TYPE_UNSPECIFIED",      "status": "JOB_STATUS_UNSPECIFIED",      "started_at": "2023-01-15T01:30:15.01Z",      "completed_at": "2023-01-15T01:30:15.01Z",      "created_at": "2023-01-15T01:30:15.01Z"    }  ],  "next_page_token": "string"}