Update an alert route

Update 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.

PUT /v1/alert_routes/{id}

Update an alert route

cURL

curl --request PUT \
  --url https://api.rootly.com/v1/alert_routes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "alert_routes",
    "attributes": {
      "name": "<string>",
      "enabled": true,
      "alerts_source_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "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_type": "AlertField",
                  "conditionable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                }
              ],
              "position": 123
            }
          ],
          "position": 123,
          "fallback_rule": false
        }
      ]
    }
  }
}
'

import requests

url = "https://api.rootly.com/v1/alert_routes/{id}"

payload = { "data": {
        "type": "alert_routes",
        "attributes": {
            "name": "<string>",
            "enabled": True,
            "alerts_source_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "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_type": "AlertField",
                                    "conditionable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                                }
                            ],
                            "position": 123
                        }
                    ],
                    "position": 123,
                    "fallback_rule": False
                }
            ]
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    data: {
      type: 'alert_routes',
      attributes: {
        name: '<string>',
        enabled: true,
        alerts_source_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        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_type: 'AlertField',
                    conditionable_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                  }
                ],
                position: 123
              }
            ],
            position: 123,
            fallback_rule: false
          }
        ]
      }
    }
  })
};

fetch('https://api.rootly.com/v1/alert_routes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/alert_routes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'type' => 'alert_routes',
        'attributes' => [
                'name' => '<string>',
                'enabled' => true,
                'alerts_source_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                '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_type' => 'AlertField',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'conditionable_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                ],
                                                                                                                                                                                                                                                                'position' => 123
                                                                                                                                ]
                                                                ],
                                                                'position' => 123,
                                                                'fallback_rule' => false
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/vnd.api+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/alert_routes/{id}"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"alert_routes\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"enabled\": true,\n      \"alerts_source_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"owning_team_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"rules\": [\n        {\n          \"name\": \"<string>\",\n          \"destinations\": [\n            {\n              \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n            }\n          ],\n          \"condition_groups\": [\n            {\n              \"conditions\": [\n                {\n                  \"property_field_name\": \"<string>\",\n                  \"property_field_value\": \"<string>\",\n                  \"property_field_values\": [\n                    \"<string>\"\n                  ],\n                  \"alert_urgency_ids\": [\n                    \"<string>\"\n                  ],\n                  \"conditionable_type\": \"AlertField\",\n                  \"conditionable_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n                }\n              ],\n              \"position\": 123\n            }\n          ],\n          \"position\": 123,\n          \"fallback_rule\": false\n        }\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.rootly.com/v1/alert_routes/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"type\": \"alert_routes\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"enabled\": true,\n      \"alerts_source_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"owning_team_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"rules\": [\n        {\n          \"name\": \"<string>\",\n          \"destinations\": [\n            {\n              \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n            }\n          ],\n          \"condition_groups\": [\n            {\n              \"conditions\": [\n                {\n                  \"property_field_name\": \"<string>\",\n                  \"property_field_value\": \"<string>\",\n                  \"property_field_values\": [\n                    \"<string>\"\n                  ],\n                  \"alert_urgency_ids\": [\n                    \"<string>\"\n                  ],\n                  \"conditionable_type\": \"AlertField\",\n                  \"conditionable_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n                }\n              ],\n              \"position\": 123\n            }\n          ],\n          \"position\": 123,\n          \"fallback_rule\": false\n        }\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/alert_routes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"type\": \"alert_routes\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"enabled\": true,\n      \"alerts_source_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"owning_team_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"rules\": [\n        {\n          \"name\": \"<string>\",\n          \"destinations\": [\n            {\n              \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n            }\n          ],\n          \"condition_groups\": [\n            {\n              \"conditions\": [\n                {\n                  \"property_field_name\": \"<string>\",\n                  \"property_field_value\": \"<string>\",\n                  \"property_field_values\": [\n                    \"<string>\"\n                  ],\n                  \"alert_urgency_ids\": [\n                    \"<string>\"\n                  ],\n                  \"conditionable_type\": \"AlertField\",\n                  \"conditionable_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n                }\n              ],\n              \"position\": 123\n            }\n          ],\n          \"position\": 123,\n          \"fallback_rule\": false\n        }\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "<string>",
    "type": "alert_routes",
    "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_type": "AlertField",
                  "conditionable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                }
              ],
              "position": 123
            }
          ],
          "position": 123,
          "fallback_rule": false
        }
      ]
    }
  }
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Body

application/vnd.api+json

data · object · required

Show child attributes

Response

200

application/vnd.api+json

update: handles mixed position types correctly

data · object · required

Show child attributes