Get one playbook run

GET

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

GET

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

$ curl https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "data": {
3     "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4     "spaceId": "space-1234",
5     "playbookId": "playbook-5678",
6     "playbookVersion": 3,
7     "playbookName": "Incident Response Playbook",
8     "status": "running",
9     "fileScope": {
10       "mode": "space"
11     },
12     "taskProgress": {
13       "total": 10,
14       "completed": 4
15     },
16     "pendingApproval": {
17       "id": "approval-9876",
18       "kind": "pre",
19       "actionName": "Restart Server",
20       "requestedAt": "2024-04-20T14:45:00Z"
21     },
22     "result": null,
23     "error": null,
24     "startedBy": "user-42",
25     "createdAt": "2024-04-20T14:00:00Z",
26     "updatedAt": "2024-04-20T15:00:00Z",
27     "finishedAt": null,
28     "currentActivity": "Waiting for approval on 'Restart Server'",
29     "snapshot": {
30       "playbookId": "playbook-5678",
31       "version": 3,
32       "name": "Incident Response Playbook",
33       "description": "Steps to handle server incidents and outages.",
34       "tasks": [
35         {
36           "id": "task-001",
37           "title": "Identify Issue",
38           "dependsOn": [],
39           "status": "completed",
40           "summary": "Issue identified as network outage.",
41           "completedAt": "2024-04-20T14:10:00Z",
42           "instructions": "Gather logs and error messages from affected systems."
43         },
44         {
45           "id": "task-002",
46           "title": "Notify Team",
47           "dependsOn": [
48             "task-001"
49           ],
50           "status": "completed",
51           "summary": "Team notified via Slack and email.",
52           "completedAt": "2024-04-20T14:15:00Z",
53           "instructions": "Send alert to on-call engineers."
54         },
55         {
56           "id": "task-003",
57           "title": "Restart Server",
58           "dependsOn": [
59             "task-002"
60           ],
61           "status": "pending",
62           "summary": null,
63           "completedAt": null,
64           "instructions": "Perform a controlled restart of the affected server."
65         }
66       ],
67       "actions": [
68         {
69           "installedActionId": "action-abc123",
70           "preApproval": true,
71           "postApproval": false,
72           "dependsOn": [
73             "task-002"
74           ],
75           "actionSlug": "restart-server",
76           "actionName": "Restart Server",
77           "trigger": "agent",
78           "browserSession": {
79             "status": "pairing",
80             "createdAt": "2024-04-20T14:40:00Z"
81           }
82         }
83       ],
84       "fileScope": {
85         "mode": "space"
86       }
87     }
88   }
89 }

Fetches one playbook run with full detail: current status, task progress, any pending approval, current activity, result/error, and the immutable snapshot of the playbook (tasks + actions + fileScope) captured at launch. Authorization: space:read (org admins bypass); missing → 404; 404 also when the run does not exist in this space. Returns { data: PlaybookRunDetail }.

Fetches one playbook run with full detail: current status, task progress, any pending approval, current activity, result/error, and the immutable snapshot of the playbook (tasks + actions + fileScope) captured at launch. Authorization: `space:read` (org admins bypass); missing → 404; 404 also when the run does not exist in this space. Returns `{ data: PlaybookRunDetail }`.

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

runIdstringRequired

Response

The playbook run, with its launch snapshot.

dataobject

Errors

404

Not Found Error