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": "2459d722-06b7-407b-a5be-8944fe17a2ba",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "5acf990a-cfe5-4e0e-8591-80719bd421dc",
        "db98ecc3-3488-402b-99e4-8db211e0691f"
      ],
      "service_ids": [
        "270fffca-7c86-4745-8d31-3efbd4ec8b93",
        "3d14f067-da3c-414d-b6fe-a9b6dcd709be"
      ],
      "functionality_ids": [
        "aa18f249-a312-4ef1-a631-01f61b59a672",
        "59d6f4b4-0041-4e66-bb2d-e00bfe6a677e"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-05T17:55:38.771-08:00",
      "updated_at": "2025-12-05T17:55:38.771-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "5acf990a-cfe5-4e0e-8591-80719bd421dc",
            "type": "environments"
          },
          {
            "id": "db98ecc3-3488-402b-99e4-8db211e0691f",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "270fffca-7c86-4745-8d31-3efbd4ec8b93",
            "type": "services"
          },
          {
            "id": "3d14f067-da3c-414d-b6fe-a9b6dcd709be",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "aa18f249-a312-4ef1-a631-01f61b59a672",
            "type": "functionalities"
          },
          {
            "id": "59d6f4b4-0041-4e66-bb2d-e00bfe6a677e",
            "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