Runs
List runs
Common filter fields: application_id, environment_id, status.
Use to view run history for an environment.
Scope: run: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:
application_id: runs for a specific application (UUID).environment_id: runs to a specific environment (UUID).status: filter by run status (PENDING, PLANNING, APPLYING, SUCCEEDED, ...).change_set_id: runs for a specific change set (UUID).
Example: field['environment_id'] = '<uuid>' AND field['status'] = 'SUCCEEDED'
Length
length <= 1024page_size?page_size
Maximum number of runs to return per page. Defaults to 50 when omitted or 0; must not exceed 100.
Format
int32Range
0 <= value <= 100page_token?page_token
Opaque pagination token from a previous response.
Response Body
application/json
curl -X GET "https://example.com/v1/runs"{ "runs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c", "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4", "status": "RUN_STATUS_UNSPECIFIED", "triggered_by": { "id": "string", "display_name": "string", "email": "string" }, "message": "string", "source_run_id": "string", "change_set_id": "string", "revision_summary": { "total": 0, "succeeded": 0, "failed": 0, "blocked": 0, "running": 0, "canceled": 0, "pending": 0 }, "completed_at": "2023-01-15T01:30:15.01Z", "display_id": "string", "application_name": "string", "environment_name": "string", "change_set_display_id": "string", "change_set_title": "string", "created_at": "2023-01-15T01:30:15.01Z" } ], "next_page_token": "string"}