playbooks_get
Fetch a playbook by name or ID, returning its YAML in a ZIP file. This enables retrieving playbook definitions from the XSIAM API for review or backup.
Instructions
Get a playbook
Get a playbook by filtering based on its name or ID. The playbook's YAML is returned in a ZIP file.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/playbooks/get] · Playbooks
Example request body:
{
"request_data": {
"filters": {
"field": "name",
"value": "Phishingplaybook"
}
}
}Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"request_data": "<request_data>"
},
"name": "playbooks_get"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| request_data | Yes |