AlertRoutes

Get an alert route

Get a specific alert route by id. Note: This endpoint requires access to Advanced Alert Routing. If you’re unsure whether you have access to this feature, please contact Rootly customer support.

Optional Parameters

show_nested_ids (query parameter): When set to true, the response will include IDs for all nested resources (destinations, condition_groups, conditions). This is useful when you need to reference these nested resources for updates or deletions via PATCH requests.

Example: GET /v1/alert_routes/{id}?show_nested_ids=true

GET

alert_routes

{id}

Get an alert route

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

{
  "data": {
    "id": "<string>",
    "attributes": {
      "name": "<string>",
      "alerts_source_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "enabled": true,
      "owning_team_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "rules": [
        {
          "name": "<string>",
          "destinations": [
            {
              "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "condition_groups": [
            {
              "conditions": [
                {
                  "property_field_name": "<string>",
                  "property_field_value": "<string>",
                  "property_field_values": [
                    "<string>"
                  ],
                  "alert_urgency_ids": [
                    "<string>"
                  ],
                  "conditionable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                }
              ],
              "position": 123
            }
          ],
          "position": 123,
          "fallback_rule": false
        }
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Response

alert route found

data

object

required

Show child attributes

Update an alert routeUpdate a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ### Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule updates happen in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after update. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.

⌘I

Get an alert route

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

{
  "data": {
    "id": "<string>",
    "attributes": {
      "name": "<string>",
      "alerts_source_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "enabled": true,
      "owning_team_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "rules": [
        {
          "name": "<string>",
          "destinations": [
            {
              "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "condition_groups": [
            {
              "conditions": [
                {
                  "property_field_name": "<string>",
                  "property_field_value": "<string>",
                  "property_field_values": [
                    "<string>"
                  ],
                  "alert_urgency_ids": [
                    "<string>"
                  ],
                  "conditionable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                }
              ],
              "position": 123
            }
          ],
          "position": 123,
          "fallback_rule": false
        }
      ]
    }
  }
}

Documentation Index

Authorizations

Path Parameters

Response