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": "66a9e412-0063-4b84-94d5-a09c32148646",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "3a27ff3d-b0b8-4f6d-b6ba-630ad9fb6624",
        "d1a914f8-c84d-4996-808b-036f22c9477a"
      ],
      "service_ids": [
        "7b2488a1-384d-4ac7-822a-f9abae4da6d7",
        "4781c1dc-e1a8-4685-9abc-539516b56c7b"
      ],
      "functionality_ids": [
        "5bbadb95-4ca4-4478-9c55-9b4a45e1f24d",
        "68a27680-8262-4f7c-b548-23de37a3ee46"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-24T09:27:36.127-08:00",
      "updated_at": "2025-12-24T09:27:36.127-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "3a27ff3d-b0b8-4f6d-b6ba-630ad9fb6624",
            "type": "environments"
          },
          {
            "id": "d1a914f8-c84d-4996-808b-036f22c9477a",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "7b2488a1-384d-4ac7-822a-f9abae4da6d7",
            "type": "services"
          },
          {
            "id": "4781c1dc-e1a8-4685-9abc-539516b56c7b",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "5bbadb95-4ca4-4478-9c55-9b4a45e1f24d",
            "type": "functionalities"
          },
          {
            "id": "68a27680-8262-4f7c-b548-23de37a3ee46",
            "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