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": "785f88f1-97e6-4fb8-8676-84a4677409a6",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"b7ca1959-53ec-45ca-bbe0-e2c19167a8f0",
"700cf971-af1b-40e8-aa57-415d776b5540"
],
"service_ids": [
"232097a5-f721-4b5f-b631-f61944cec2d8",
"a22baa15-7935-4151-885a-e2832a6b5328"
],
"functionality_ids": [
"2058cc38-d17a-409b-acc4-4ac053802941",
"20dc4786-da02-41a5-8312-974dc8659400"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-10-09T08:39:20.132-07:00",
"updated_at": "2025-10-09T08:39:20.132-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "b7ca1959-53ec-45ca-bbe0-e2c19167a8f0",
"type": "environments"
},
{
"id": "700cf971-af1b-40e8-aa57-415d776b5540",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "232097a5-f721-4b5f-b631-f61944cec2d8",
"type": "services"
},
{
"id": "a22baa15-7935-4151-885a-e2832a6b5328",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "2058cc38-d17a-409b-acc4-4ac053802941",
"type": "functionalities"
},
{
"id": "20dc4786-da02-41a5-8312-974dc8659400",
"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": "785f88f1-97e6-4fb8-8676-84a4677409a6",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"b7ca1959-53ec-45ca-bbe0-e2c19167a8f0",
"700cf971-af1b-40e8-aa57-415d776b5540"
],
"service_ids": [
"232097a5-f721-4b5f-b631-f61944cec2d8",
"a22baa15-7935-4151-885a-e2832a6b5328"
],
"functionality_ids": [
"2058cc38-d17a-409b-acc4-4ac053802941",
"20dc4786-da02-41a5-8312-974dc8659400"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-10-09T08:39:20.132-07:00",
"updated_at": "2025-10-09T08:39:20.132-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "b7ca1959-53ec-45ca-bbe0-e2c19167a8f0",
"type": "environments"
},
{
"id": "700cf971-af1b-40e8-aa57-415d776b5540",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "232097a5-f721-4b5f-b631-f61944cec2d8",
"type": "services"
},
{
"id": "a22baa15-7935-4151-885a-e2832a6b5328",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "2058cc38-d17a-409b-acc4-4ac053802941",
"type": "functionalities"
},
{
"id": "20dc4786-da02-41a5-8312-974dc8659400",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}