List notification rules

GET

/v1/notificationrule/

const url = 'https://example.com/v1/notificationrule/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://example.com/v1/notificationrule/ \
  --header 'Authorization: Bearer <token>'

Return all notification rules for the current account.

Authorizations

jwtAuth
basicAuth

Parameters

Query Parameters

cursor

string

The pagination cursor value.

name

string

page_size

integer

Number of results to return per page.

search

string

A search term.

Responses

200

application/json

object

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object

agent

string format: uuid

nullable

agent_offline

boolean

agent_tag

string

nullable

contacts_groups

Array<string>

created_at

required

string format: date-time

created_by

required

string format: uuid

nullable

custom_grace_period

Custom grace period in seconds

integer

nullable <= 300

enabled

boolean

required

string format: uuid

metric_item

string

nullable

metric_label

string

nullable <= 100 characters

metric_labels_text

string

nullable

metric_display_name

required

string

modified_at

required

string format: date-time

modified_by

required

string format: uuid

nullable

name

string

<= 100 characters

recording_rule

string format: uuid

nullable

repeatable_delay

Delay in minutes to repeat notification

integer

<= 2147483647

server_group

string format: uuid

nullable

targets

Array<string>

on_call_schedules

Array<string>

Example

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
}