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 source
Update a specific alert source by id
curl --request PUT \
--url https://api.rootly.com/v1/alert_sources/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "alert_sources",
"attributes": {
"name": "<string>",
"source_type": "email",
"alert_urgency_id": "<string>",
"alert_template_attributes": {
"title": "<string>",
"description": "<string>",
"external_url": "<string>"
},
"alert_source_urgency_rules_attributes": [
{
"json_path": "<string>",
"operator": "is",
"value": "<string>"
}
],
"sourceable_attributes": {
"auto_resolve": true,
"resolve_state": "<string>",
"field_mappings_attributes": [
{
"field": "external_id",
"json_path": "<string>"
}
]
}
}
}
}'{
"data": {
"id": "977fd0fa-084b-4483-879e-2c2a380eb91a",
"type": "alert_sources",
"attributes": {
"name": "GW 2",
"source_type": "datadog",
"status": "setup_incomplete",
"secret": "36556f9da185b62b292aac4f6ce2722f97d0c067e919c275c6cfe43e3ae8d04e",
"alert_urgency_id": "f1dbd118-89aa-4d1d-b917-d5bb08ba75bc",
"created_at": "2025-03-22T22:57:46.705-07:00",
"updated_at": "2025-03-22T22:57:50.557-07:00",
"webhook_endpoint": "http://localhost:3001/webhooks/incoming/datadog_webhooks/notify/<TYPE>/<ID>",
"sourceable_attributes": {},
"alert_template_attributes": {}
},
"relationships": {
"alert_source_urgency_rules": {
"data": [
{
"id": "771cfc0a-cbd0-4346-a5d9-c0369c345d75",
"alerts_source_id": "977fd0fa-084b-4483-879e-2c2a380eb91a",
"alert_urgency_id": "a79e1e96-9650-4956-b077-b0c26eb7da3f",
"json_path": "$.alert.status",
"operator": "is",
"value": "Critical",
"deleted_at": null,
"created_at": "2025-03-22T22:57:50.558-07:00",
"updated_at": "2025-03-22T22:57:50.558-07:00"
}
]
}
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
alert_sources The name of the alert source
The alert source type
email, app_dynamics, catchpoint, datadog, alertmanager, google_cloud, grafana, sentry, generic_webhook, cloud_watch, checkly, azure, new_relic, splunk, chronosphere, app_optics, bug_snag, honeycomb, monte_carlo, nagios, prtg ID for the default alert urgency assigned to this alert source
List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload
JSON path expression to extract a specific value from the alert's payload for evaluation
Comparison operator used to evaluate the extracted value against the specified condition
is, is_not, contains, does_not_contain Value that the extracted payload data is compared to using the specified operator to determine a match
Provide additional attributes for generic_webhook alerts source
Set this to true to auto-resolve alerts based on field_mappings_attributes conditions
This value is matched with the value extracted from alerts payload using JSON path in field_mappings_attributes
Specify rules to auto resolve alerts
Select the field on which the condition to be evaluated
external_id, state, alert_title, alert_external_url, notification_target_type, notification_target_id JSON path expression to extract a specific value from the alert's payload for evaluation
Response
Unique ID of the alert source
alert_sources The name of the alert source
The current status of the alert source
A secret key used to authenticate incoming requests to this alerts source
The URL endpoint of the alert source
Date of creation
Date of last update
ID for the default alert urgency assigned to this alert source
The alert source type
Additional attributes specific to certain alert sources (e.g., generic_webhook), encapsulating source-specific configurations or details
Was this page helpful?
curl --request PUT \
--url https://api.rootly.com/v1/alert_sources/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "alert_sources",
"attributes": {
"name": "<string>",
"source_type": "email",
"alert_urgency_id": "<string>",
"alert_template_attributes": {
"title": "<string>",
"description": "<string>",
"external_url": "<string>"
},
"alert_source_urgency_rules_attributes": [
{
"json_path": "<string>",
"operator": "is",
"value": "<string>"
}
],
"sourceable_attributes": {
"auto_resolve": true,
"resolve_state": "<string>",
"field_mappings_attributes": [
{
"field": "external_id",
"json_path": "<string>"
}
]
}
}
}
}'{
"data": {
"id": "977fd0fa-084b-4483-879e-2c2a380eb91a",
"type": "alert_sources",
"attributes": {
"name": "GW 2",
"source_type": "datadog",
"status": "setup_incomplete",
"secret": "36556f9da185b62b292aac4f6ce2722f97d0c067e919c275c6cfe43e3ae8d04e",
"alert_urgency_id": "f1dbd118-89aa-4d1d-b917-d5bb08ba75bc",
"created_at": "2025-03-22T22:57:46.705-07:00",
"updated_at": "2025-03-22T22:57:50.557-07:00",
"webhook_endpoint": "http://localhost:3001/webhooks/incoming/datadog_webhooks/notify/<TYPE>/<ID>",
"sourceable_attributes": {},
"alert_template_attributes": {}
},
"relationships": {
"alert_source_urgency_rules": {
"data": [
{
"id": "771cfc0a-cbd0-4346-a5d9-c0369c345d75",
"alerts_source_id": "977fd0fa-084b-4483-879e-2c2a380eb91a",
"alert_urgency_id": "a79e1e96-9650-4956-b077-b0c26eb7da3f",
"json_path": "$.alert.status",
"operator": "is",
"value": "Critical",
"deleted_at": null,
"created_at": "2025-03-22T22:57:50.558-07:00",
"updated_at": "2025-03-22T22:57:50.558-07:00"
}
]
}
}
}
}