Cancel a playbook run | CloudRaker documentation

Cancels the run (terminal). Authorization: space:contribute (org admins bypass); missing → 403. Body: optional reason (1–4000 chars) recorded on the run. Returns 200 { data } with the run’s final status, task progress, result and error.

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

runIdstringRequired

Request

This endpoint expects an object.

reasonstringOptional1-4000 characters

Response

The final run state.

dataobject

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

1	{
2	"data": {
3	"status": "cancelled",
4	"taskProgress": {
5	"total": 5,
6	"completed": 3
7	},
8	"pendingApproval": {
9	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
10	"kind": "pre",
11	"actionName": "Verify cancellation",
12	"requestedAt": "2024-04-20T14:45:00Z"
13	},
14	"currentActivity": "Cancelling remaining tasks",
15	"result": "Run cancelled successfully",
16	"error": ""
17	}
18	}