Skip to main content
POST
/
v1
/
playbooks
Creates a playbook
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": "ab84dff6-c7d9-47c3-be45-3226d55c8f9d",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "26910f2c-390a-4795-9deb-c7e8d077f775",
        "874273ca-71c1-43cf-be56-0e8cf7d489f3"
      ],
      "service_ids": [
        "9199b50d-4658-46e4-b2b9-e80064067468",
        "753b758a-92b3-4b86-af4f-621ebcd4844d"
      ],
      "functionality_ids": [
        "02ba5bf1-f078-4e04-86ca-e2b066880de6",
        "e4a01825-8edd-4372-9c24-7989eba456da"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-03T14:04:08.038-08:00",
      "updated_at": "2026-02-03T14:04:08.038-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "26910f2c-390a-4795-9deb-c7e8d077f775",
            "type": "environments"
          },
          {
            "id": "874273ca-71c1-43cf-be56-0e8cf7d489f3",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "9199b50d-4658-46e4-b2b9-e80064067468",
            "type": "services"
          },
          {
            "id": "753b758a-92b3-4b86-af4f-621ebcd4844d",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "02ba5bf1-f078-4e04-86ca-e2b066880de6",
            "type": "functionalities"
          },
          {
            "id": "e4a01825-8edd-4372-9c24-7989eba456da",
            "type": "functionalities"
          }
        ]
      },
      "groups": {
        "data": []
      },
      "causes": {
        "data": []
      },
      "incident_types": {
        "data": []
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json
data
object
required

Response

playbook created

data
object
required