AlertRoutes

Creates an alert route

Creates a new alert route from provided data. 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 creation happens in the background.

Asynchronous processing is also applied automatically, whether or not it is enabled for your organization, when a request carries a rule graph too large to save within the request timeout. Size is measured in total dependent records — rules plus their condition groups, conditions and destinations — and for an update it includes the rules already on the route, not just those in the payload.

Important: Whenever rules are processed asynchronously, the rules list in the API response will not be up-to-date immediately after creation. You should refetch the alert route, or poll the async rule creation status endpoint with the request_id you supplied, to confirm the rules have landed.

If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.

POST

alert_routes

Creates an alert route

curl --request POST \
  --url https://api.rootly.com/v1/alert_routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "alert_routes"
  }
}
'

import requests

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

payload = { "data": { "type": "alert_routes" } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({data: {type: 'alert_routes'}})
};

fetch('https://api.rootly.com/v1/alert_routes', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'type' => 'alert_routes'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"alert_routes\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.rootly.com/v1/alert_routes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"type\": \"alert_routes\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"type\": \"alert_routes\"\n  }\n}"

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

{
  "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_type": "Service",
              "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "condition_groups": [
            {
              "conditions": [
                {
                  "property_field_condition_type": "is_one_of",
                  "property_field_name": "<string>",
                  "property_field_type": "attribute",
                  "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.

Body

application/vnd.api+json

data

object

Show child attributes

Response

unknown attribute filtered out gracefully

data

object

required

Show child attributes

⌘I

Creates an alert route

curl --request POST \
  --url https://api.rootly.com/v1/alert_routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "alert_routes"
  }
}
'

import requests

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

payload = { "data": { "type": "alert_routes" } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({data: {type: 'alert_routes'}})
};

fetch('https://api.rootly.com/v1/alert_routes', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'type' => 'alert_routes'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"alert_routes\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.rootly.com/v1/alert_routes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"type\": \"alert_routes\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"type\": \"alert_routes\"\n  }\n}"

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

{
  "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_type": "Service",
              "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "condition_groups": [
            {
              "conditions": [
                {
                  "property_field_condition_type": "is_one_of",
                  "property_field_name": "<string>",
                  "property_field_type": "attribute",
                  "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>"
    }
  ]
}