Admiral

Changesets

Retrieve a revision's plan

GET
/v1/changesets/{change_set_id}/revisions/{revision}/plan

Scope: changeset: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

change_set_id*change_set_id

The change_set_id path parameter.

Match^cs-[0-9a-z]{12}$
revision*revision

The revision path parameter.

Formatint32
Range1 <= value

Response Body

application/json

curl -X GET "https://example.com/v1/changesets/string/revisions/1/plan"
{  "plan": {    "revision": 0,    "job_id": "string",    "status": "JOB_STATUS_UNSPECIFIED",    "wait_reason": "WAIT_REASON_UNSPECIFIED",    "agent_id": "string",    "agent_name": "string",    "cluster_id": "string",    "cluster_name": "string",    "plan_digest": "string",    "components": [      {        "component": "string",        "changes": [          {            "resource": {              "api_version": "string",              "kind": "string",              "namespace": "string",              "name": "string"            },            "action": "RESOURCE_ACTION_UNSPECIFIED",            "diff_digest": "string"          }        ]      }    ],    "message": "string",    "created_at": "2023-01-15T01:30:15.01Z",    "finished_at": "2023-01-15T01:30:15.01Z",    "approvals": [      {        "revision": 0,        "plan_digest": "string",        "approved_by": {          "id": "string",          "display_name": "string",          "email": "string"        },        "self_approval": true,        "reason": "string",        "approved_at": "2023-01-15T01:30:15.01Z"      }    ]  }}