diff --git a/content/en/api/v2/monitors/examples.json b/content/en/api/v2/monitors/examples.json index aadd419de0c25..f3249194f2e2f 100644 --- a/content/en/api/v2/monitors/examples.json +++ b/content/en/api/v2/monitors/examples.json @@ -101,7 +101,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of monitor notification rules.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rules.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of monitor notification rules.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitor notifications by tags. A monitor notification must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Filter monitor notifications. A monitor notification must match the scope.

\n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rules.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -226,7 +226,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitor notifications by tags. A monitor notification must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Filter monitor notifications. A monitor notification must match the scope.

\n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -305,7 +305,7 @@ "type": "monitor-notification-rule" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object to create a monitor notification rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object to create a monitor notification rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitor notifications by tags. A monitor notification must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Filter monitor notifications. A monitor notification must match the scope.

\n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
" } }, "DeleteMonitorNotificationRule": { @@ -441,7 +441,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitor notifications by tags. A monitor notification must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Filter monitor notifications. A monitor notification must match the scope.

\n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -574,7 +574,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitor notifications by tags. A monitor notification must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Filter monitor notifications. A monitor notification must match the scope.

\n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -663,7 +663,7 @@ "type": "monitor-notification-rule" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object to update a monitor notification rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object to update a monitor notification rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitor notifications by tags. A monitor notification must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Filter monitor notifications. A monitor notification must match the scope.

\n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
" } }, "ListMonitorConfigPolicies": { diff --git a/content/en/api/v2/monitors/request.CreateMonitorNotificationRule_1379932371.json b/content/en/api/v2/monitors/request.CreateMonitorNotificationRule_1379932371.json new file mode 100644 index 0000000000000..3e1bd93a1237c --- /dev/null +++ b/content/en/api/v2/monitors/request.CreateMonitorNotificationRule_1379932371.json @@ -0,0 +1,15 @@ +{ + "data": { + "attributes": { + "filter": { + "scope": "test:example-monitor" + }, + "name": "test rule", + "recipients": [ + "slack-test-channel", + "jira-test" + ] + }, + "type": "monitor-notification-rule" + } +} \ No newline at end of file diff --git a/content/en/api/v2/monitors/request.UpdateMonitorNotificationRule_1446058210.json b/content/en/api/v2/monitors/request.UpdateMonitorNotificationRule_1446058210.json new file mode 100644 index 0000000000000..b6449eea12595 --- /dev/null +++ b/content/en/api/v2/monitors/request.UpdateMonitorNotificationRule_1446058210.json @@ -0,0 +1,15 @@ +{ + "data": { + "attributes": { + "filter": { + "scope": "test:example-monitor" + }, + "name": "updated rule", + "recipients": [ + "slack-test-channel" + ] + }, + "id": "00000000-0000-1234-0000-000000000000", + "type": "monitor-notification-rule" + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index dffc45f448ac3..53a4675259617 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -1108,6 +1108,11 @@ "group": "monitors", "suffix": "_1181818787", "description": "Create a monitor notification rule with conditional recipients returns \"OK\" response" + }, + { + "group": "monitors", + "suffix": "_1379932371", + "description": "Create a monitor notification rule with scope returns \"OK\" response" } ], "CreateMonitorUserTemplate": [ @@ -1134,6 +1139,11 @@ "group": "monitors", "suffix": "_1400905713", "description": "Update a monitor notification rule with conditional_recipients returns \"OK\" response" + }, + { + "group": "monitors", + "suffix": "_1446058210", + "description": "Update a monitor notification rule with scope returns \"OK\" response" } ], "UpdateMonitorUserTemplate": [ diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index d6574615abcc3..f7b5ab3bab626 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -32955,15 +32955,23 @@ components: properties: recipients: $ref: '#/components/schemas/MonitorNotificationRuleRecipients' + description: A list of recipients to notify. Uses the same format as the + monitor `message` field. Must not start with an '@'. scope: - $ref: '#/components/schemas/MonitorNotificationRuleScope' + $ref: '#/components/schemas/MonitorNotificationRuleConditionScope' required: - scope - recipients type: object + MonitorNotificationRuleConditionScope: + description: The scope to which the monitor applied. + example: transition_type:alert + maxLength: 3000 + minLength: 1 + type: string MonitorNotificationRuleConditionalRecipients: description: Use conditional recipients to define different recipients for different - situations. + situations. Cannot be used with `recipients`. properties: conditions: description: Conditions of the notification rule. @@ -33013,12 +33021,30 @@ components: description: Filter used to associate the notification rule with monitors. oneOf: - $ref: '#/components/schemas/MonitorNotificationRuleFilterTags' + - $ref: '#/components/schemas/MonitorNotificationRuleFilterScope' + MonitorNotificationRuleFilterScope: + additionalProperties: false + description: Filter monitor notifications. A monitor notification must match + the scope. + properties: + scope: + description: A scope composed of one or several key:value pairs, which can + be used to filter monitor notifications on monitor and group tags. + example: service:(foo OR bar) AND team:test NOT environment:staging + maxLength: 3000 + minLength: 1 + type: string + required: + - scope + type: object MonitorNotificationRuleFilterTags: additionalProperties: false - description: Filter monitors by tags. Monitors must match all tags. + description: Filter monitor notifications by tags. A monitor notification must + match all tags. properties: tags: - description: A list of monitor tags. + description: A list of tags (key:value pairs), which can be used to filter + monitor notifications on monitor and group tags. example: - team:product - host:abc @@ -33058,7 +33084,7 @@ components: type: string MonitorNotificationRuleRecipients: description: A list of recipients to notify. Uses the same format as the monitor - `message` field. Must not start with an '@'. + `message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`. example: - slack-test-channel - jira-test @@ -33141,12 +33167,6 @@ components: description: An object related to a monitor notification rule. oneOf: - $ref: '#/components/schemas/User' - MonitorNotificationRuleScope: - description: The scope to which the monitor applied. - example: transition_type:alert - maxLength: 3000 - minLength: 1 - type: string MonitorNotificationRuleUpdateRequest: description: Request for updating a monitor notification rule. properties: