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": "b7d4dada-3198-4ec7-b763-614680c8478b",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "ade324f7-08bd-4a8f-8590-e72323dc8acf",
        "aea8cdc8-a7a8-4a7f-805d-e8c08211f86f"
      ],
      "service_ids": [
        "050c0fc9-de4a-4bff-8e28-14ac620059e0",
        "3948be96-a6ac-434e-bc93-91d80eaeb639"
      ],
      "functionality_ids": [
        "cc253de9-11cb-4000-a202-39f78339d562",
        "e86de2c2-f0e7-48e2-96b1-7b84bac9de7c"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-04T08:42:18.294-08:00",
      "updated_at": "2025-12-04T08:42:18.294-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "ade324f7-08bd-4a8f-8590-e72323dc8acf",
            "type": "environments"
          },
          {
            "id": "aea8cdc8-a7a8-4a7f-805d-e8c08211f86f",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "050c0fc9-de4a-4bff-8e28-14ac620059e0",
            "type": "services"
          },
          {
            "id": "3948be96-a6ac-434e-bc93-91d80eaeb639",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "cc253de9-11cb-4000-a202-39f78339d562",
            "type": "functionalities"
          },
          {
            "id": "e86de2c2-f0e7-48e2-96b1-7b84bac9de7c",
            "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