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": "91b6d406-9bf7-4bab-b630-c6ae8aedeb9b",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "b7f25424-8970-4849-acb4-2a155ceaddcf",
        "2cf36723-3421-41b0-929f-e122ba1abd39"
      ],
      "service_ids": [
        "a6760c92-62f5-457b-94aa-9aa6081d5b5f",
        "aefe0776-0adb-4253-b6eb-52a509023ee9"
      ],
      "functionality_ids": [
        "8d52c6e9-aedc-43c8-94d3-bfbe34b2e049",
        "d2a90f0e-0e25-4d3b-8803-13350f0061d4"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-03-19T07:53:59.405-07:00",
      "updated_at": "2025-03-19T07:53:59.405-07:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "b7f25424-8970-4849-acb4-2a155ceaddcf",
            "type": "environments"
          },
          {
            "id": "2cf36723-3421-41b0-929f-e122ba1abd39",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "a6760c92-62f5-457b-94aa-9aa6081d5b5f",
            "type": "services"
          },
          {
            "id": "aefe0776-0adb-4253-b6eb-52a509023ee9",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "8d52c6e9-aedc-43c8-94d3-bfbe34b2e049",
            "type": "functionalities"
          },
          {
            "id": "d2a90f0e-0e25-4d3b-8803-13350f0061d4",
            "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