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": "764fa743-7d7d-45f1-8463-d95a7c2938eb",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "df1f9554-836e-499c-afc1-fc8928962771",
        "f824853e-2065-4e13-86f0-bfa43475693f"
      ],
      "service_ids": [
        "c14c50fb-80eb-4aca-93e5-dfc151d39f32",
        "530fa687-d107-47e7-93bf-f72ab18f154b"
      ],
      "functionality_ids": [
        "b59434e6-fa6d-44de-a83f-4209b5dc8cd6",
        "f75c158f-bed4-488d-8868-528c7de8b668"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-10T18:28:48.386-08:00",
      "updated_at": "2025-12-10T18:28:48.386-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "df1f9554-836e-499c-afc1-fc8928962771",
            "type": "environments"
          },
          {
            "id": "f824853e-2065-4e13-86f0-bfa43475693f",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "c14c50fb-80eb-4aca-93e5-dfc151d39f32",
            "type": "services"
          },
          {
            "id": "530fa687-d107-47e7-93bf-f72ab18f154b",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "b59434e6-fa6d-44de-a83f-4209b5dc8cd6",
            "type": "functionalities"
          },
          {
            "id": "f75c158f-bed4-488d-8868-528c7de8b668",
            "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