Decide a playbook run approval

POST

/spaces/:spaceId/playbook-runs/:runId/approvals/:approvalId

POST

/spaces/:spaceId/playbook-runs/:runId/approvals/:approvalId

$ curl -X POST https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/approvals/approvalId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "decision": "approve"
> }'

1 {
2   "data": {
3     "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4     "kind": "pre",
5     "actionSlug": "deploy-infrastructure",
6     "installedActionId": "action-12345",
7     "actionName": "Deploy Infrastructure",
8     "actionRunId": "run-67890",
9     "rationale": "Pre-deployment check passed successfully.",
10     "files": [
11       {
12         "id": "file-98765",
13         "name": "infrastructure-plan.yaml"
14       }
15     ],
16     "params": {},
17     "artifacts": [
18       {
19         "id": "artifact-54321",
20         "kind": "link",
21         "title": "Deployment Logs",
22         "url": "https://cloudraker.com/logs/deploy-67890",
23         "open": "tab"
24       }
25     ],
26     "status": "approved",
27     "requestedAt": "2024-01-15T09:30:00Z",
28     "decidedBy": "user-112233",
29     "decidedAt": "2024-01-15T09:45:00Z",
30     "note": "Approved after verifying all checks.",
31     "editedParams": {},
32     "editedFileIds": [
33       "file-98765"
34     ]
35   }
36 }

Approves or rejects a pending approval on the run — either a pre-action gate (allow the action to run) or a post-action output review. Authorization: space:contribute (org admins bypass); missing → 403. Body: decision (“approve” | “reject”, required); optional note (≤4000 chars); and, when approving, you may edit before proceeding — editedParams (override the action params), editedFileIds (1–200, override the input files), editedOutput (override the reviewed output). The request body is capped at 1 MiB → 413 payload_too_large if exceeded. Returns 200 { data: Approval } with the updated approval.

Approves or rejects a pending approval on the run — either a pre-action gate (allow the action to run) or a post-action output review. Authorization: `space:contribute` (org admins bypass); missing → 403. Body: `decision` ("approve" | "reject", required); optional `note` (≤4000 chars); and, when approving, you may edit before proceeding — `editedParams` (override the action params), `editedFileIds` (1–200, override the input files), `editedOutput` (override the reviewed output). The request body is capped at 1 MiB → 413 `payload_too_large` if exceeded. Returns 200 `{ data: Approval }` with the updated approval.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

runIdstringRequired

approvalIdstringRequired

Request

The whole body is capped at 1 MiB (413 payload_too_large beyond it).

decisionenumRequired

Allowed values:

notestringOptional<=4000 characters

Required when rejecting.

editedParamsmap from strings to anyOptional

Override the action parameters.

editedFileIdslist of stringsOptional

editedOutputanyOptional

Override the reviewed output.

Response

The updated approval.

dataobject

Errors

413

Content Too Large Error