Overview
AlertEvents
AlertGroups
AlertRoutingRules
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
[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
- GETList incidents
- POSTCreates an incident
- GETRetrieves an incident
- PUTUpdate an incident
- DELDelete an incident
- PUTMitigate an incident
- PUTResolve an incident
- PUTCancel an incident
- PUTTriage an incident
- PUTRestart an incident
- PUTMark an incident as a duplicate
- POSTAdd subscribers to incident
- DELRemove subscribers from incident
- POSTAssign user to incident
- DELRemove assigned user from incident
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
WebhooksDeliveries
Update a playbook
Update a specific playbook by id
curl --request PUT \
--url https://api.rootly.com/v1/playbooks/{id} \
--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": "bcc3622d-1bd1-4a73-9df4-01bc777fd080",
"type": "playbooks",
"attributes": {
"title": "How to handle security incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-03-28T23:03:50.436-07:00",
"updated_at": "2025-03-28T23:03:54.935-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
playbooks
The title of the playbook
The summary of the playbook
The external url of the playbook
The Severity ID's to attach to the incident
The Environment ID's to attach to the incident
The Service ID's to attach to the incident
The Functionality ID's to attach to the incident
The Team ID's to attach to the incident
The Incident Type ID's to attach to the incident
Response
Unique ID of the playbook
playbooks
The title of the playbook
Date of creation
Date of last update
The summary of the playbook
The external url of the playbook
The Severity ID's to attach to the incident
The Environment ID's to attach to the incident
The Functionality ID's to attach to the incident
The Service ID's to attach to the incident
The Team ID's to attach to the incident
The Incident Type ID's to attach to the incident
Was this page helpful?
curl --request PUT \
--url https://api.rootly.com/v1/playbooks/{id} \
--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": "bcc3622d-1bd1-4a73-9df4-01bc777fd080",
"type": "playbooks",
"attributes": {
"title": "How to handle security incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-03-28T23:03:50.436-07:00",
"updated_at": "2025-03-28T23:03:54.935-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}