POST
/
v1
/
playbooks
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": "acf168f3-7f92-40ea-b691-6f62624838f9",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "5e92bf5e-c506-4d19-a674-4de4f0387c88",
        "3330d487-1b23-433e-af09-47277ecb3d09"
      ],
      "service_ids": [
        "4edbc0f4-fe4b-444b-82e2-5bb270b485a8",
        "ed046fef-dd35-4f87-b724-c58249778102"
      ],
      "functionality_ids": [
        "35827b10-c272-49b3-b162-c34ab7cbaa8b",
        "db50afc7-dd49-4389-9eb5-de7cbc86100d"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-03-28T23:03:53.089-07:00",
      "updated_at": "2025-03-28T23:03:53.089-07:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "5e92bf5e-c506-4d19-a674-4de4f0387c88",
            "type": "environments"
          },
          {
            "id": "3330d487-1b23-433e-af09-47277ecb3d09",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "4edbc0f4-fe4b-444b-82e2-5bb270b485a8",
            "type": "services"
          },
          {
            "id": "ed046fef-dd35-4f87-b724-c58249778102",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "35827b10-c272-49b3-b162-c34ab7cbaa8b",
            "type": "functionalities"
          },
          {
            "id": "db50afc7-dd49-4389-9eb5-de7cbc86100d",
            "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

201
application/vnd.api+json
playbook created
data
object
required