Archive playbook

POST

/playbooks/:id/archive

POST

/playbooks/:id/archive

1 curl -X POST https:/https://api/playbooks/id/archive \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "playbook": {
3     "_id": "63f1a2b4e7a1c9d2f4b5e678",
4     "scope": "library",
5     "templateId": "tpl_9f8e7d6c5b4a3210",
6     "projectId": "proj_1234567890abcdef",
7     "sourceDefinitionId": "def_abcdef1234567890",
8     "sourceVersion": 1.1,
9     "slug": "incident-response-2024",
10     "name": "Incident Response Playbook",
11     "description": "A playbook for managing and responding to security incidents.",
12     "icon": "🚨",
13     "color": "#FF5733",
14     "status": "archived",
15     "numbering": {
16       "steps": "1.1",
17       "tasks": "1.1.1"
18     },
19     "startableByUsers": true,
20     "webhookEnabled": true,
21     "webhookSecret": "whsec_4f3e2d1c0b9a8e7d6c5b4a3f2e1d0c9b",
22     "orchestrator": {
23       "type": "sequential",
24       "retryPolicy": "exponentialBackoff"
25     },
26     "startForm": {
27       "fields": [
28         {
29           "name": "incident_type",
30           "type": "dropdown",
31           "options": [
32             "phishing",
33             "malware",
34             "data_breach"
35           ]
36         }
37       ]
38     },
39     "tasks": [
40       {
41         "taskId": "task_001",
42         "name": "Identify Incident",
43         "description": "Gather initial information about the incident."
44       }
45     ],
46     "dependencies": [
47       {
48         "dependencyId": "dep_001",
49         "name": "Network Monitoring"
50       }
51     ],
52     "version": 1.1,
53     "archivedAt": "2024-06-01T10:15:30Z",
54     "briefId": "brief_20240601",
55     "createdAt": "2023-12-15T08:00:00Z",
56     "updatedAt": "2024-06-01T10:15:30Z",
57     "createdBy": "user_7890abcdef123456"
58   }
59 }

Transitions an active playbook to archived. Fails with 409 when the playbook is not currently active.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

idstringRequired

Response

The archived playbook.

playbookobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error