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 an alert group
Update a specific alert group by id
curl --request PATCH \
--url https://api.rootly.com/v1/alert_groups/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "alert_groups",
"attributes": {
"name": "<string>",
"description": "<string>",
"time_window": 123,
"targets": [
{
"target_type": "Group",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"attributes": [
{
"json_path": "<string>"
}
],
"group_by_alert_title": 1,
"group_by_alert_urgency": 1,
"condition_type": "all"
}
}
}'
{
"data": {
"id": "ebae8403-dedf-4153-a931-839f31b840c7",
"type": "alert_groups",
"attributes": {
"name": "Group name updated",
"slug": "123-test-group",
"description": null,
"time_window": 10,
"condition_type": "any",
"group_by_alert_title": false,
"group_by_alert_urgency": false,
"deleted_at": null,
"created_at": "2025-03-22T22:57:29.972-07:00",
"updated_at": "2025-03-22T22:57:31.820-07:00",
"targets": [
{
"id": "4c0ccac8-c7e9-4a7a-8706-7864419af74d",
"target_type": "Service",
"target_id": "7b6608eb-b896-404b-9d66-65a64a4bb1ac",
"alert_group_id": "ebae8403-dedf-4153-a931-839f31b840c7",
"deleted_at": null,
"created_at": "2025-03-22T22:57:29.974-07:00",
"updated_at": "2025-03-22T22:57:29.974-07:00"
}
],
"attributes": []
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
alert_groups
The name of the alert group
The description of the alert group
The length of time an Alert Group should stay open and accept new alerts
The JSON path to the value to group by.
Whether the alerts should be grouped by titles.
1
, 0
Whether the alerts should be grouped by urgencies.
1
, 0
Group alerts when ANY or ALL of the fields are matching.
all
, any
Response
Unique ID of the alert group
alert_groups
The name of the alert group
The description of the alert group
The slug of the alert group
Grouping condition for the alert group
Time window for the alert grouping
Whether the alerts are grouped by title or not
Whether the alerts are grouped by urgency or not
Date of creation
Date of last update
Date or deletion
Was this page helpful?
curl --request PATCH \
--url https://api.rootly.com/v1/alert_groups/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "alert_groups",
"attributes": {
"name": "<string>",
"description": "<string>",
"time_window": 123,
"targets": [
{
"target_type": "Group",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"attributes": [
{
"json_path": "<string>"
}
],
"group_by_alert_title": 1,
"group_by_alert_urgency": 1,
"condition_type": "all"
}
}
}'
{
"data": {
"id": "ebae8403-dedf-4153-a931-839f31b840c7",
"type": "alert_groups",
"attributes": {
"name": "Group name updated",
"slug": "123-test-group",
"description": null,
"time_window": 10,
"condition_type": "any",
"group_by_alert_title": false,
"group_by_alert_urgency": false,
"deleted_at": null,
"created_at": "2025-03-22T22:57:29.972-07:00",
"updated_at": "2025-03-22T22:57:31.820-07:00",
"targets": [
{
"id": "4c0ccac8-c7e9-4a7a-8706-7864419af74d",
"target_type": "Service",
"target_id": "7b6608eb-b896-404b-9d66-65a64a4bb1ac",
"alert_group_id": "ebae8403-dedf-4153-a931-839f31b840c7",
"deleted_at": null,
"created_at": "2025-03-22T22:57:29.974-07:00",
"updated_at": "2025-03-22T22:57:29.974-07:00"
}
],
"attributes": []
}
}
}