List alertmanager routes API Reference

GET

/tenants/{tenant}/alertmanager/routes

const url = 'https://api.kupe.cloud/api/v1/tenants/acme/alertmanager/routes';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.kupe.cloud/api/v1/tenants/acme/alertmanager/routes \
  --header 'Authorization: <Authorization>'

Returns the child routes of the root. The root route itself is implicit (it always exists with the default receiver). Each child route declares matchers and a target receiver.

Authorizations

BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

Responses

200

Routes

application/json

object

items

Array<object>

object

active_time_intervals

Array<string>

continue

boolean

group_by

Array<string>

group_interval

string

group_wait

string

match

object

key

additional properties

string

match_re

object

key

additional properties

string

matchers

Array<string>

mute_time_intervals

Array<string>

receiver

string

repeat_interval

string

Example

{
  "items": [
    {
      "continue": false,
      "group_by": [
        "alertname",
        "cluster"
      ],
      "group_interval": "5m",
      "group_wait": "30s",
      "matchers": [
        "severity=\"critical\""
      ],
      "receiver": "slack",
      "repeat_interval": "4h"
    }
  ]
}