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": "e32de5d5-64ed-4dc7-9b26-7ecd1369b750",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "5444e10b-17c0-43dd-8960-c70efa8c2ed8",
        "97bfd293-e027-4a3b-adaf-a713075b2673"
      ],
      "service_ids": [
        "35ccab25-1302-400a-bdd2-73ddc4642e6f",
        "f863b17a-c0a2-490e-8808-3d990724abd1"
      ],
      "functionality_ids": [
        "d84af662-4051-4df4-b33b-1479020027c7",
        "67f6f298-80a5-432d-aacc-81724e5dfdc7"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-18T04:09:29.482-08:00",
      "updated_at": "2025-12-18T04:09:29.482-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "5444e10b-17c0-43dd-8960-c70efa8c2ed8",
            "type": "environments"
          },
          {
            "id": "97bfd293-e027-4a3b-adaf-a713075b2673",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "35ccab25-1302-400a-bdd2-73ddc4642e6f",
            "type": "services"
          },
          {
            "id": "f863b17a-c0a2-490e-8808-3d990724abd1",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "d84af662-4051-4df4-b33b-1479020027c7",
            "type": "functionalities"
          },
          {
            "id": "67f6f298-80a5-432d-aacc-81724e5dfdc7",
            "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