Runs
List runs
Scope: run:read
Authorization
bearerAuth AuthorizationBearer <token>
An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...
In: header
Query Parameters
filter?filter
Filter expression to narrow results. Uses the Admiral filter DSL.
Filterable fields:
id: runs by id, for fetching several at once (field['id'] IN [...]).environment_id: runs of one environment.change_set_id: runs of one change set.status: filter by run status.kind:change_set,drift_checkorreapply, which is what started the run (a revision, ordesiredwith its mode).
Example: field['environment_id'] = 'env-7q2k9m4x8p1c' AND field['kind'] = 'change_set'
Length
length <= 1024page_size?page_size
The page_size query parameter.
Format
int32Range
0 <= value <= 100page_token?page_token
The page_token query parameter.
Response Body
application/json
curl -X GET "https://example.com/v1/runs"{ "runs": [ { "id": "string", "environment_id": "string", "change_set_id": "string", "status": "STATUS_UNSPECIFIED", "trigger": "TRIGGER_UNSPECIFIED", "wait_reason": "WAIT_REASON_UNSPECIFIED", "plan": { "jobs": [ { "job_id": "string", "components": [ "string" ], "assignment_id": "string", "agent_id": "string", "status": "JOB_STATUS_UNSPECIFIED", "wait_reason": "WAIT_REASON_UNSPECIFIED" } ], "plan_digest": "string", "components": [ { "component": "string", "changes": [ { "resource": { "kubernetes": { "api_version": "string", "kind": "string", "namespace": "string", "name": "string" } }, "action": "ACTION_UNSPECIFIED", "diff_digest": "string" } ], "plan_file_digest": "string" } ], "message": "string", "started_at": "2023-01-15T01:30:15.01Z", "finished_at": "2023-01-15T01:30:15.01Z" }, "apply": { "jobs": [ { "job_id": "string", "components": [ "string" ], "assignment_id": "string", "agent_id": "string", "status": "JOB_STATUS_UNSPECIFIED", "wait_reason": "WAIT_REASON_UNSPECIFIED" } ], "components": [ { "component": "string", "status": "STATUS_UNSPECIFIED", "message": "string" } ], "message": "string", "applied_by": { "id": "string", "display_name": "string", "email": "string" }, "generation": "string", "started_at": "2023-01-15T01:30:15.01Z", "finished_at": "2023-01-15T01:30:15.01Z", "accepted_by": { "id": "string", "display_name": "string", "email": "string" }, "accepted_reason": "string", "accepted_at": "2023-01-15T01:30:15.01Z" }, "approvals": [ { "plan_digest": "string", "approved_by": { "id": "string", "display_name": "string", "email": "string" }, "reason": "string", "approved_at": "2023-01-15T01:30:15.01Z", "carried_from_run_id": "string" } ], "created_by": { "id": "string", "display_name": "string", "email": "string" }, "created_at": "2023-01-15T01:30:15.01Z", "finished_at": "2023-01-15T01:30:15.01Z", "required_approval": { "required_approvals": 0, "groups": [ { "group_id": "string", "approvals": 1 } ] }, "desired": { "mode": "MODE_UNSPECIFIED", "components": [ "string" ], "generation": "string", "desired_components": [ { "component": "string", "revision_id": "string" } ] } } ], "next_page_token": "string"}