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": "f5f16b2d-81de-40eb-a449-dd4cfc4122b7",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"bd9935ff-f270-4dff-8d04-a65ee22151f5",
"24e53e8b-2c1a-4658-933a-dff8b93d986d"
],
"service_ids": [
"214212cc-9de8-4c9b-9d24-f429a63bdc2b",
"b01df2a8-f9fb-4368-bd87-602c1de6a9be"
],
"functionality_ids": [
"b0f8ed3a-381b-47e3-939a-77f4efba19f8",
"95b38929-39f0-42de-b615-11f0edc2a1d2"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-12-03T07:00:54.538-08:00",
"updated_at": "2025-12-03T07:00:54.538-08:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "bd9935ff-f270-4dff-8d04-a65ee22151f5",
"type": "environments"
},
{
"id": "24e53e8b-2c1a-4658-933a-dff8b93d986d",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "214212cc-9de8-4c9b-9d24-f429a63bdc2b",
"type": "services"
},
{
"id": "b01df2a8-f9fb-4368-bd87-602c1de6a9be",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "b0f8ed3a-381b-47e3-939a-77f4efba19f8",
"type": "functionalities"
},
{
"id": "95b38929-39f0-42de-b615-11f0edc2a1d2",
"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": "f5f16b2d-81de-40eb-a449-dd4cfc4122b7",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"bd9935ff-f270-4dff-8d04-a65ee22151f5",
"24e53e8b-2c1a-4658-933a-dff8b93d986d"
],
"service_ids": [
"214212cc-9de8-4c9b-9d24-f429a63bdc2b",
"b01df2a8-f9fb-4368-bd87-602c1de6a9be"
],
"functionality_ids": [
"b0f8ed3a-381b-47e3-939a-77f4efba19f8",
"95b38929-39f0-42de-b615-11f0edc2a1d2"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-12-03T07:00:54.538-08:00",
"updated_at": "2025-12-03T07:00:54.538-08:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "bd9935ff-f270-4dff-8d04-a65ee22151f5",
"type": "environments"
},
{
"id": "24e53e8b-2c1a-4658-933a-dff8b93d986d",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "214212cc-9de8-4c9b-9d24-f429a63bdc2b",
"type": "services"
},
{
"id": "b01df2a8-f9fb-4368-bd87-602c1de6a9be",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "b0f8ed3a-381b-47e3-939a-77f4efba19f8",
"type": "functionalities"
},
{
"id": "95b38929-39f0-42de-b615-11f0edc2a1d2",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}