Get Playbook by ID
Retrieves playbooks given an internal playbook ID.
Path parameters
The playbook ID to retrieve
Response
The playbook was successfully retrieved
Example response
{
"contributors": [
"['John Doe'",
" 'Jane Smith']"
],
"createTime": "2024-11-14T15:03:22Z",
"created": "2023-10-01T12:00:00Z",
"description": "This is a sample playbook",
"detection_category": "process_creation",
"detection_id": "ac5856cd-7e4c-4a61-8b15-6fc9148ff7f2",
"id": "PdFc-JIBLkNJ8-bDfz47",
"kind": "case",
"modified": "2023-10-01T12:00:00Z",
"name": "Sample Playbook",
"operation": "create",
"questions": [
{
"context": "Knowing if the attack comes from inside or outside the network can help determine if this is a false positive or a real attack.",
"queryResults": [
{
"id": "ru5Jk5MB4OVrR03M8ee8",
"payload": {
"@timestamp": "2024-12-04T20:06:04.725Z",
"@version": "1",
"client.ip": "4.33.51.1",
"client.port": "5544"
},
"sort": [
"0:33.32.12.56"
],
"source": "so:.ds-logs-zeek-so-2024.11.21-000017",
"time": "2024-12-04T20:08:15.97Z",
"timestamp": "2024-12-04T20:08:15.970Z"
}
],
"question": "What is the source IP address of the alert?",
"range": "+/-3d"
}
],
"updateTime": "2024-11-14T15:33:02Z",
"userId": "socl_my_new_client"
}Changes
Changed in 5 of the 23 revisions of this API.116
- ○
added the optional property
questions/items/fieldsto the response with the200statusresponse-optional-property-added
- ○
added the optional property
questions/items/oqlQueryto the response with the200statusresponse-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the optional property
questions/items/filledQueryto the response with the200statusresponse-optional-property-added
- ○
added the optional property
questions/items/queryResultsto the response with the200statusresponse-optional-property-added
- ○
- ●
removed the optional property
datefrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
createdto the response with the200statusresponse-optional-property-added
- ●
- ○
endpoint added
endpoint-added
- ○
- ▲
api path removed without deprecation
api-path-removed-without-deprecation
This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲