ListTestNotificationRecipients - Cortex XCOR Documentation

cURL

curl --request POST \
  --url https://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "include_previews": true,
  "signal_labels": "{\"env\": \"prod\"}"
}
'

package main

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

func main() {

	url := "https://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients"

	payload := strings.NewReader("{\n  \"include_previews\": true,\n  \"signal_labels\": \"{\\\"env\\\": \\\"prod\\\"}\"\n}")

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

	req.Header.Add("API-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/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://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients")
  .header("API-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"include_previews\": true,\n  \"signal_labels\": \"{\\\"env\\\": \\\"prod\\\"}\"\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {'API-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({include_previews: true, signal_labels: '{"env": "prod"}'})
};

fetch('https://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients"

payload = {
    "include_previews": True,
    "signal_labels": "{\"env\": \"prod\"}"
}
headers = {
    "API-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "recipients": [
    {
      "display_name": "<string>",
      "id": "<string>",
      "preview_markdown": "<string>",
      "type": "EMAIL"
    }
  ]
}

{
  "message": "<string>"
}

POST

/

api

/

v1

/

state

/

monitors

/

{monitor_slug}

:list-test-notification-recipients

cURL

curl --request POST \
  --url https://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "include_previews": true,
  "signal_labels": "{\"env\": \"prod\"}"
}
'

package main

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

func main() {

	url := "https://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients"

	payload := strings.NewReader("{\n  \"include_previews\": true,\n  \"signal_labels\": \"{\\\"env\\\": \\\"prod\\\"}\"\n}")

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

	req.Header.Add("API-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/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://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients")
  .header("API-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"include_previews\": true,\n  \"signal_labels\": \"{\\\"env\\\": \\\"prod\\\"}\"\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {'API-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({include_previews: true, signal_labels: '{"env": "prod"}'})
};

fetch('https://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{tenant}.chronosphere.io/api/v1/state/monitors/{monitor_slug}:list-test-notification-recipients"

payload = {
    "include_previews": True,
    "signal_labels": "{\"env\": \"prod\"}"
}
headers = {
    "API-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "recipients": [
    {
      "display_name": "<string>",
      "id": "<string>",
      "preview_markdown": "<string>",
      "type": "EMAIL"
    }
  ]
}

{
  "message": "<string>"
}

Authorizations

API-Token

string

header

required

Chronosphere API token

Path Parameters

monitor_slug

string

required

The slug of the saved monitor.

Body

application/json

include_previews

boolean

Render each recipient's notification preview. Previews cost a render per integration, so leave this false when only recipient IDs are needed.

severity

enum<string>

The severity to resolve recipients for. Must be WARN or CRITICAL.

Available options:

WARN,

CRITICAL

signal_labels

object

Labels of the signal the test notification is for. When the monitor groups signals by label names, only those names are accepted; when it uses one signal per series, any name is accepted; when it has no signal grouping, none are accepted. Names starting with __chrono_, alertname, and severity, are reserved.

Show child attributes

Example:

"{\"env\": \"prod\"}"

Response

A successful response.

recipients

object[]

Every recipient reachable from the monitor's notification policy at the severity, using the policy's default routes and then every override route, each listed once. Override label matchers are not applied. Empty when the monitor has no notification policy.

Show child attributes