Retrieves a playbook

GET

playbooks

{id}

curl --request GET \
  --url https://api.rootly.com/v1/playbooks/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "playbooks",
    "attributes": {
      "title": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "summary": "<string>",
      "external_url": "<string>",
      "severity_ids": [
        "<string>"
      ],
      "environment_ids": [
        "<string>"
      ],
      "functionality_ids": [
        "<string>"
      ],
      "service_ids": [
        "<string>"
      ],
      "group_ids": [
        "<string>"
      ],
      "incident_type_ids": [
        "<string>"
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Query Parameters

include

enum<string>

comma separated if needed. eg: severities,environments,services

Available options:

severities,

environments,

services,

functionalities,

groups,

causes,

incident_types

Response

playbook found

data

object

required

Show child attributes

data.id

string

required

Unique ID of the playbook

data.type

enum<string>

required

Available options:

playbooks

data.attributes

object

required

Show child attributes

data.attributes.title

string

required

The title of the playbook

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.summary

string | null

The summary of the playbook

data.attributes.external_url

string | null

The external url of the playbook

data.attributes.severity_ids

string[] | null

The Severity ID's to attach to the incident

data.attributes.environment_ids

string[] | null

The Environment ID's to attach to the incident

data.attributes.functionality_ids

string[] | null

The Functionality ID's to attach to the incident

data.attributes.service_ids

string[] | null

The Service ID's to attach to the incident

data.attributes.group_ids

string[] | null

The Team ID's to attach to the incident

data.attributes.incident_type_ids

string[] | null

The Incident Type ID's to attach to the incident

Update a playbookUpdate a specific playbook by id

⌘I

Retrieves a playbook

curl --request GET \
  --url https://api.rootly.com/v1/playbooks/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "playbooks",
    "attributes": {
      "title": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "summary": "<string>",
      "external_url": "<string>",
      "severity_ids": [
        "<string>"
      ],
      "environment_ids": [
        "<string>"
      ],
      "functionality_ids": [
        "<string>"
      ],
      "service_ids": [
        "<string>"
      ],
      "group_ids": [
        "<string>"
      ],
      "incident_type_ids": [
        "<string>"
      ]
    }
  }
}

Overview

AlertEvents

AlertFields

AlertGroups

AlertRoutes

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

Communications Groups

Communications Stages

Communications Templates

Communications Types

[DEPRECATED] CustomFieldOptions

[DEPRECATED] CustomFields

CustomForms

DashboardPanels

Dashboards

Environments

EscalationPolicies

EscalationLevelsPolicies

EscalationLevelsPath

EscalationLevels

EscalationPaths

FormFieldOptions

FormFieldPlacementConditions

FormFieldPlacements

FormFieldPositions

FormFields

FormSetConditions

FormSets

Functionalities

WorkflowTasks

[DEPRECATED] WorkflowCustomFieldSelections

WorkflowFormFieldConditions

WorkflowGroups

WorkflowRuns

Workflows

Heartbeats

IncidentActionItems

[DEPRECATED] IncidentCustomFieldSelections

IncidentEventFunctionalities

IncidentEventServices

IncidentEvents

IncidentFeedbacks

IncidentFormFieldSelections

IncidentPermissionSetBooleans

IncidentPermissionSetResources

IncidentPermissionSets

IncidentRetrospectives

IncidentRetrospectiveSteps

IncidentRoleTasks

IncidentRoles

IncidentStatusPageEvents

IncidentSubStatuses

IncidentTypes

Incidents

IpRanges

LiveCallRouters

OnCallRoles

OnCallShadows

OverrideShifts

PlaybookTasks

Playbooks

RetrospectiveTemplates

Pulses

RetrospectiveConfigurations

RetrospectiveProcessGroupSteps

RetrospectiveProcessGroups

RetrospectiveProcesses

RetrospectiveSteps

Roles

ScheduleRotationActiveDays