Overview
Reference
- AlertEvents
- AlertGroups
- AlertUrgencies
- AlertSources
- Alerts
- Audits
- Authorizations
- CatalogEntities
- CatalogEntityProperties
- CatalogFields
- Catalogs
- Causes
- [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
- ScheduleRotationUsers
- ScheduleRotations
- Schedules
- Shifts
- Secrets
- Services
- Severities
- StatusPageTemplates
- StatusPages
- SubStatuses
- Teams
- UserNotificationRules
- Users
- WebhooksDeliveries
- WebhooksEndpoints
AlertGroups
List alert groups
AlertGroups
List alert groups
List alert groups
GET
/
v1
/
alert_groups
curl --request GET \
--url 'https://api.rootly.com/v1/alert_groups?include=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": [
{
"id": "<string>",
"type": "alert_groups",
"attributes": {
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"condition_type": "<string>",
"time_window": 123,
"group_by_alert_title": true,
"group_by_alert_urgency": true,
"targets": [
{
"target_type": "Group",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"attributes": [
{
"json_path": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
}
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Response
200 - application/vnd.api+json
success
Unique ID of the alert group
Available options:
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 GET \
--url 'https://api.rootly.com/v1/alert_groups?include=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": [
{
"id": "<string>",
"type": "alert_groups",
"attributes": {
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"condition_type": "<string>",
"time_window": 123,
"group_by_alert_title": true,
"group_by_alert_urgency": true,
"targets": [
{
"target_type": "Group",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"attributes": [
{
"json_path": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
}
}
]
}