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": "439c110b-3949-41ad-bf7f-8431bcb8ca93",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "9f04aba1-78f8-4368-b0d9-a6595b6f0cda",
        "2eac822e-9b21-4ce3-b840-b2ff15fc3c7b"
      ],
      "service_ids": [
        "15b24898-ae01-4964-b6a1-e05e3376b86d",
        "b87125be-2c9a-47c5-b9bb-99a1144570a8"
      ],
      "functionality_ids": [
        "66bcd82d-11c0-4d68-aaef-30e420ab6606",
        "b656c9db-67a0-47c6-9c28-8b74bea014dd"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-11-21T14:33:19.935-08:00",
      "updated_at": "2025-11-21T14:33:19.935-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "9f04aba1-78f8-4368-b0d9-a6595b6f0cda",
            "type": "environments"
          },
          {
            "id": "2eac822e-9b21-4ce3-b840-b2ff15fc3c7b",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "15b24898-ae01-4964-b6a1-e05e3376b86d",
            "type": "services"
          },
          {
            "id": "b87125be-2c9a-47c5-b9bb-99a1144570a8",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "66bcd82d-11c0-4d68-aaef-30e420ab6606",
            "type": "functionalities"
          },
          {
            "id": "b656c9db-67a0-47c6-9c28-8b74bea014dd",
            "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