Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/vnd.api+json
Response
playbook created
Creates a new playbook from provided data
curl --request POST \
--url https://api.rootly.com/v1/playbooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "playbooks",
"attributes": {
"title": "<string>",
"summary": "<string>",
"external_url": "<string>",
"severity_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"service_ids": [
"<string>"
],
"functionality_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"incident_type_ids": [
"<string>"
]
}
}
}
'{
"data": {
"id": "fc7c2eb3-16a2-4261-a426-2e1027d99a6a",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"3e4a3118-91f4-4eb7-a939-787d1ef12f42",
"8b6be160-ffd8-4e2a-bca6-3ddf6b302360"
],
"service_ids": [
"367a28e7-581a-4b02-b527-89e889e05d4b",
"ff761cf0-95c4-4999-9626-7f68184f33ff"
],
"functionality_ids": [
"3500abdd-55d3-42a4-b8c5-aa25fc9368a5",
"364f5291-d99e-4206-98de-242c940f024d"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-12-03T13:54:56.185-08:00",
"updated_at": "2025-12-03T13:54:56.185-08:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "3e4a3118-91f4-4eb7-a939-787d1ef12f42",
"type": "environments"
},
{
"id": "8b6be160-ffd8-4e2a-bca6-3ddf6b302360",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "367a28e7-581a-4b02-b527-89e889e05d4b",
"type": "services"
},
{
"id": "ff761cf0-95c4-4999-9626-7f68184f33ff",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "3500abdd-55d3-42a4-b8c5-aa25fc9368a5",
"type": "functionalities"
},
{
"id": "364f5291-d99e-4206-98de-242c940f024d",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Show child attributes
playbook created
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.rootly.com/v1/playbooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "playbooks",
"attributes": {
"title": "<string>",
"summary": "<string>",
"external_url": "<string>",
"severity_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"service_ids": [
"<string>"
],
"functionality_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"incident_type_ids": [
"<string>"
]
}
}
}
'{
"data": {
"id": "fc7c2eb3-16a2-4261-a426-2e1027d99a6a",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"3e4a3118-91f4-4eb7-a939-787d1ef12f42",
"8b6be160-ffd8-4e2a-bca6-3ddf6b302360"
],
"service_ids": [
"367a28e7-581a-4b02-b527-89e889e05d4b",
"ff761cf0-95c4-4999-9626-7f68184f33ff"
],
"functionality_ids": [
"3500abdd-55d3-42a4-b8c5-aa25fc9368a5",
"364f5291-d99e-4206-98de-242c940f024d"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-12-03T13:54:56.185-08:00",
"updated_at": "2025-12-03T13:54:56.185-08:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "3e4a3118-91f4-4eb7-a939-787d1ef12f42",
"type": "environments"
},
{
"id": "8b6be160-ffd8-4e2a-bca6-3ddf6b302360",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "367a28e7-581a-4b02-b527-89e889e05d4b",
"type": "services"
},
{
"id": "ff761cf0-95c4-4999-9626-7f68184f33ff",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "3500abdd-55d3-42a4-b8c5-aa25fc9368a5",
"type": "functionalities"
},
{
"id": "364f5291-d99e-4206-98de-242c940f024d",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}