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": "cd0c8a0f-698e-4517-a960-e5f376529c38",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "c540b671-0414-46c7-b3c1-331d8336eeeb",
        "6d980d53-b354-4cda-bdb2-3f6675f9b047"
      ],
      "service_ids": [
        "86b829ac-359f-4c3c-8021-741eee49fc72",
        "2e41f588-aaa1-4f70-94c6-9f3dba5fd705"
      ],
      "functionality_ids": [
        "686f7f82-9770-4b3f-b218-7a2e1ce2032b",
        "df4cd7d8-6467-4b76-8acb-a8f3c743215b"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-08T15:55:27.978-08:00",
      "updated_at": "2025-12-08T15:55:27.978-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "c540b671-0414-46c7-b3c1-331d8336eeeb",
            "type": "environments"
          },
          {
            "id": "6d980d53-b354-4cda-bdb2-3f6675f9b047",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "86b829ac-359f-4c3c-8021-741eee49fc72",
            "type": "services"
          },
          {
            "id": "2e41f588-aaa1-4f70-94c6-9f3dba5fd705",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "686f7f82-9770-4b3f-b218-7a2e1ce2032b",
            "type": "functionalities"
          },
          {
            "id": "df4cd7d8-6467-4b76-8acb-a8f3c743215b",
            "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