Admiral

Runs

Accept a partial apply

POST
/v1/runs/{run_id}/accept

Scope: run:write

Authorization

bearerAuth
AuthorizationBearer <token>

An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...

In: header

Path Parameters

run_id*run_id

The run_id path parameter.

Match^run-[0-9a-z]+$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/runs/string/accept" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
{  "run": {    "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": {                "api_version": "string",                "kind": "string",                "namespace": "string",                "name": "string"              },              "action": "ACTION_UNSPECIFIED",              "diff_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"        }      ]    }  }}