diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index fbce49d3a6c..4c96777e567 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -9440,6 +9440,66 @@ menu: url: /api/latest/on-call/ identifier: on-call generated: true + - name: Update an On-Call notification rule for a user + url: '#update-an-on-call-notification-rule-for-a-user' + identifier: on-call-update-an-on-call-notification-rule-for-a-user + parent: on-call + generated: true + params: + versions: + - v2 + operationids: + - UpdateUserNotificationRule + unstable: [] + order: 21 + - name: Get an On-Call notification rule for a user + url: '#get-an-on-call-notification-rule-for-a-user' + identifier: on-call-get-an-on-call-notification-rule-for-a-user + parent: on-call + generated: true + params: + versions: + - v2 + operationids: + - GetUserNotificationRule + unstable: [] + order: 20 + - name: Delete an On-Call notification rule for a user + url: '#delete-an-on-call-notification-rule-for-a-user' + identifier: on-call-delete-an-on-call-notification-rule-for-a-user + parent: on-call + generated: true + params: + versions: + - v2 + operationids: + - DeleteUserNotificationRule + unstable: [] + order: 19 + - name: Create an On-Call notification rule for a user + url: '#create-an-on-call-notification-rule-for-a-user' + identifier: on-call-create-an-on-call-notification-rule-for-a-user + parent: on-call + generated: true + params: + versions: + - v2 + operationids: + - CreateUserNotificationRule + unstable: [] + order: 17 + - name: List On-Call notification rules for a user + url: '#list-on-call-notification-rules-for-a-user' + identifier: on-call-list-on-call-notification-rules-for-a-user + parent: on-call + generated: true + params: + versions: + - v2 + operationids: + - ListUserNotificationRules + unstable: [] + order: 18 - name: Get an On-Call notification channel for a user url: '#get-an-on-call-notification-channel-for-a-user' identifier: on-call-get-an-on-call-notification-channel-for-a-user diff --git a/content/en/api/v2/on-call/examples.json b/content/en/api/v2/on-call/examples.json index 0aad07a5782..9b636f01ace 100644 --- a/content/en/api/v2/on-call/examples.json +++ b/content/en/api/v2/on-call/examples.json @@ -1855,5 +1855,428 @@ "json": {}, "html": "" } + }, + "ListUserNotificationRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "category": "string", + "channel_settings": { + "method": "sms", + "type": "phone" + }, + "delay_minutes": "integer" + }, + "id": "string", + "relationships": { + "channel": { + "data": { + "id": "string", + "type": "notification_channels" + } + } + }, + "type": "notification_rules" + } + ], + "included": [ + { + "attributes": { + "active": false, + "config": { + "formatted_number": "", + "number": "", + "region": "", + "sms_subscribed_at": "2019-09-19T10:00:00.000Z", + "type": "phone", + "verified": false + } + }, + "id": "string", + "type": "notification_channels" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

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

attributes

\n
\n

object

\n

Attributes for an on-call notification rule.

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

category

\n
\n

enum

\n

Specifies the category a notification rule will apply to \nAllowed enum values: high_urgency,low_urgency

default: high_urgency

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

channel_settings

\n
\n

 <oneOf>

\n

Configuration for the associated channel, if necessary

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

Option 1

\n
\n

object

\n

Configuration for using a phone notification channel in a notification rule

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

method [required]

\n
\n

enum

\n

Specifies the method in which a phone is used in a notification rule \nAllowed enum values: sms,voice

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

delay_minutes

\n
\n

int64

\n

The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation

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

id

\n
\n

string

\n

Unique identifier for the rule

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

relationships

\n
\n

object

\n

Relationship object for creating a notification rule

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

channel

\n
\n

object

\n

Relationship object for creating a notification rule

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

data [required]

\n
\n

object

\n

Channel relationship data for creating a notification rule

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

id

\n
\n

string

\n

ID of the notification channel

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

type

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_rules'. \nAllowed enum values: notification_rules

default: notification_rules

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

included

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

Data for an on-call notification channel

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

attributes

\n
\n

object

\n

Attributes for an on-call notification channel.

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

active

\n
\n

boolean

\n

Whether the notification channel is currently active.

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

config

\n
\n

 <oneOf>

\n

Notification channel configuration

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

Option 1

\n
\n

object

\n

Phone notification channel configuration

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

formatted_number [required]

\n
\n

string

\n

The formatted international version of Number (e.g. +33 7 1 23 45 67).

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

number [required]

\n
\n

string

\n

The E-164 formatted phone number (e.g. +3371234567)

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

region [required]

\n
\n

string

\n

The ISO 3166-1 alpha-2 two-letter country code.

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

sms_subscribed_at

\n
\n

date-time

\n

If present, the date the user subscribed this number to SMS messages

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

verified [required]

\n
\n

boolean

\n

Indicates whether this phone has been verified by the user in Datadog On-Call

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

Option 2

\n
\n

object

\n

Email notification channel configuration

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

address [required]

\n
\n

string

\n

The e-mail address to be notified

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

formats [required]

\n
\n

[string]

\n

Preferred content formats for notifications.

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is an e-mail address \nAllowed enum values: email

default: email

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

Option 3

\n
\n

object

\n

Push notification channel configuration

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

application_name [required]

\n
\n

string

\n

The name of the application used to receive push notifications

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

device_name [required]

\n
\n

string

\n

The name of the mobile device being used

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a mobile device for push notifications \nAllowed enum values: push

default: push

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

id

\n
\n

string

\n

Unique identifier for the channel

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateUserNotificationRule": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "category": "high_urgency", + "channel_settings": { + "method": "sms", + "type": "phone" + }, + "delay_minutes": 1 + }, + "id": "27590dae-47be-4a7d-9abf-8f4e45124020", + "relationships": { + "channel": { + "data": { + "id": "1562fab3-a8c2-49e2-8f3a-28dcda2405e2", + "type": "notification_channels" + } + } + }, + "type": "notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for an on-call notification rule

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

attributes

\n
\n

object

\n

Attributes for an on-call notification rule.

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

category

\n
\n

enum

\n

Specifies the category a notification rule will apply to \nAllowed enum values: high_urgency,low_urgency

default: high_urgency

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

channel_settings

\n
\n

 <oneOf>

\n

Configuration for the associated channel, if necessary

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

Option 1

\n
\n

object

\n

Configuration for using a phone notification channel in a notification rule

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

method [required]

\n
\n

enum

\n

Specifies the method in which a phone is used in a notification rule \nAllowed enum values: sms,voice

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

delay_minutes

\n
\n

int64

\n

The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation

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

id

\n
\n

string

\n

Unique identifier for the rule

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

relationships

\n
\n

object

\n

Relationship object for creating a notification rule

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

channel

\n
\n

object

\n

Relationship object for creating a notification rule

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

data [required]

\n
\n

object

\n

Channel relationship data for creating a notification rule

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

id

\n
\n

string

\n

ID of the notification channel

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

type

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_rules'. \nAllowed enum values: notification_rules

default: notification_rules

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

included

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

Data for an on-call notification channel

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

attributes

\n
\n

object

\n

Attributes for an on-call notification channel.

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

active

\n
\n

boolean

\n

Whether the notification channel is currently active.

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

config

\n
\n

 <oneOf>

\n

Notification channel configuration

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

Option 1

\n
\n

object

\n

Phone notification channel configuration

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

formatted_number [required]

\n
\n

string

\n

The formatted international version of Number (e.g. +33 7 1 23 45 67).

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

number [required]

\n
\n

string

\n

The E-164 formatted phone number (e.g. +3371234567)

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

region [required]

\n
\n

string

\n

The ISO 3166-1 alpha-2 two-letter country code.

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

sms_subscribed_at

\n
\n

date-time

\n

If present, the date the user subscribed this number to SMS messages

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

verified [required]

\n
\n

boolean

\n

Indicates whether this phone has been verified by the user in Datadog On-Call

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

Option 2

\n
\n

object

\n

Email notification channel configuration

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

address [required]

\n
\n

string

\n

The e-mail address to be notified

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

formats [required]

\n
\n

[string]

\n

Preferred content formats for notifications.

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is an e-mail address \nAllowed enum values: email

default: email

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

Option 3

\n
\n

object

\n

Push notification channel configuration

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

application_name [required]

\n
\n

string

\n

The name of the application used to receive push notifications

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

device_name [required]

\n
\n

string

\n

The name of the mobile device being used

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a mobile device for push notifications \nAllowed enum values: push

default: push

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

id

\n
\n

string

\n

Unique identifier for the channel

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "relationships": { + "channel": { + "data": {} + } + }, + "type": "notification_rules" + } + }, + "json": { + "data": { + "attributes": { + "category": "string", + "channel_settings": { + "method": "sms", + "type": "phone" + }, + "delay_minutes": "integer" + }, + "relationships": { + "channel": { + "data": { + "id": "string", + "type": "notification_channels" + } + } + }, + "type": "notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for creating an on-call notification rule

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

attributes

\n
\n

object

\n

Attributes for creating or modifying an on-call notification rule.

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

category

\n
\n

enum

\n

Specifies the category a notification rule will apply to \nAllowed enum values: high_urgency,low_urgency

default: high_urgency

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

channel_settings

\n
\n

 <oneOf>

\n

Configuration for the associated channel, if necessary

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

Option 1

\n
\n

object

\n

Configuration for using a phone notification channel in a notification rule

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

method [required]

\n
\n

enum

\n

Specifies the method in which a phone is used in a notification rule \nAllowed enum values: sms,voice

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

delay_minutes

\n
\n

int64

\n

The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation

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

relationships

\n
\n

object

\n

Relationship object for creating a notification rule

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

channel

\n
\n

object

\n

Relationship object for creating a notification rule

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

data [required]

\n
\n

object

\n

Channel relationship data for creating a notification rule

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

id

\n
\n

string

\n

ID of the notification channel

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

type

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_rules'. \nAllowed enum values: notification_rules

default: notification_rules

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteUserNotificationRule": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetUserNotificationRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "category": "high_urgency", + "channel_settings": { + "method": "sms", + "type": "phone" + }, + "delay_minutes": 1 + }, + "id": "27590dae-47be-4a7d-9abf-8f4e45124020", + "relationships": { + "channel": { + "data": { + "id": "1562fab3-a8c2-49e2-8f3a-28dcda2405e2", + "type": "notification_channels" + } + } + }, + "type": "notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for an on-call notification rule

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

attributes

\n
\n

object

\n

Attributes for an on-call notification rule.

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

category

\n
\n

enum

\n

Specifies the category a notification rule will apply to \nAllowed enum values: high_urgency,low_urgency

default: high_urgency

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

channel_settings

\n
\n

 <oneOf>

\n

Configuration for the associated channel, if necessary

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

Option 1

\n
\n

object

\n

Configuration for using a phone notification channel in a notification rule

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

method [required]

\n
\n

enum

\n

Specifies the method in which a phone is used in a notification rule \nAllowed enum values: sms,voice

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

delay_minutes

\n
\n

int64

\n

The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation

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

id

\n
\n

string

\n

Unique identifier for the rule

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

relationships

\n
\n

object

\n

Relationship object for creating a notification rule

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

channel

\n
\n

object

\n

Relationship object for creating a notification rule

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

data [required]

\n
\n

object

\n

Channel relationship data for creating a notification rule

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

id

\n
\n

string

\n

ID of the notification channel

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

type

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_rules'. \nAllowed enum values: notification_rules

default: notification_rules

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

included

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

Data for an on-call notification channel

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

attributes

\n
\n

object

\n

Attributes for an on-call notification channel.

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

active

\n
\n

boolean

\n

Whether the notification channel is currently active.

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

config

\n
\n

 <oneOf>

\n

Notification channel configuration

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

Option 1

\n
\n

object

\n

Phone notification channel configuration

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

formatted_number [required]

\n
\n

string

\n

The formatted international version of Number (e.g. +33 7 1 23 45 67).

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

number [required]

\n
\n

string

\n

The E-164 formatted phone number (e.g. +3371234567)

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

region [required]

\n
\n

string

\n

The ISO 3166-1 alpha-2 two-letter country code.

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

sms_subscribed_at

\n
\n

date-time

\n

If present, the date the user subscribed this number to SMS messages

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

verified [required]

\n
\n

boolean

\n

Indicates whether this phone has been verified by the user in Datadog On-Call

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

Option 2

\n
\n

object

\n

Email notification channel configuration

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

address [required]

\n
\n

string

\n

The e-mail address to be notified

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

formats [required]

\n
\n

[string]

\n

Preferred content formats for notifications.

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is an e-mail address \nAllowed enum values: email

default: email

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

Option 3

\n
\n

object

\n

Push notification channel configuration

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

application_name [required]

\n
\n

string

\n

The name of the application used to receive push notifications

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

device_name [required]

\n
\n

string

\n

The name of the mobile device being used

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a mobile device for push notifications \nAllowed enum values: push

default: push

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

id

\n
\n

string

\n

Unique identifier for the channel

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateUserNotificationRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "category": "high_urgency", + "channel_settings": { + "method": "sms", + "type": "phone" + }, + "delay_minutes": 1 + }, + "id": "27590dae-47be-4a7d-9abf-8f4e45124020", + "relationships": { + "channel": { + "data": { + "id": "1562fab3-a8c2-49e2-8f3a-28dcda2405e2", + "type": "notification_channels" + } + } + }, + "type": "notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for an on-call notification rule

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

attributes

\n
\n

object

\n

Attributes for an on-call notification rule.

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

category

\n
\n

enum

\n

Specifies the category a notification rule will apply to \nAllowed enum values: high_urgency,low_urgency

default: high_urgency

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

channel_settings

\n
\n

 <oneOf>

\n

Configuration for the associated channel, if necessary

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

Option 1

\n
\n

object

\n

Configuration for using a phone notification channel in a notification rule

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

method [required]

\n
\n

enum

\n

Specifies the method in which a phone is used in a notification rule \nAllowed enum values: sms,voice

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

delay_minutes

\n
\n

int64

\n

The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation

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

id

\n
\n

string

\n

Unique identifier for the rule

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

relationships

\n
\n

object

\n

Relationship object for creating a notification rule

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

channel

\n
\n

object

\n

Relationship object for creating a notification rule

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

data [required]

\n
\n

object

\n

Channel relationship data for creating a notification rule

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

id

\n
\n

string

\n

ID of the notification channel

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

type

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_rules'. \nAllowed enum values: notification_rules

default: notification_rules

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

included

\n
\n

[ <oneOf>]

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

Option 1

\n
\n

object

\n

Data for an on-call notification channel

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

attributes

\n
\n

object

\n

Attributes for an on-call notification channel.

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

active

\n
\n

boolean

\n

Whether the notification channel is currently active.

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

config

\n
\n

 <oneOf>

\n

Notification channel configuration

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

Option 1

\n
\n

object

\n

Phone notification channel configuration

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

formatted_number [required]

\n
\n

string

\n

The formatted international version of Number (e.g. +33 7 1 23 45 67).

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

number [required]

\n
\n

string

\n

The E-164 formatted phone number (e.g. +3371234567)

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

region [required]

\n
\n

string

\n

The ISO 3166-1 alpha-2 two-letter country code.

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

sms_subscribed_at

\n
\n

date-time

\n

If present, the date the user subscribed this number to SMS messages

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

verified [required]

\n
\n

boolean

\n

Indicates whether this phone has been verified by the user in Datadog On-Call

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

Option 2

\n
\n

object

\n

Email notification channel configuration

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

address [required]

\n
\n

string

\n

The e-mail address to be notified

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

formats [required]

\n
\n

[string]

\n

Preferred content formats for notifications.

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is an e-mail address \nAllowed enum values: email

default: email

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

Option 3

\n
\n

object

\n

Push notification channel configuration

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

application_name [required]

\n
\n

string

\n

The name of the application used to receive push notifications

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

device_name [required]

\n
\n

string

\n

The name of the mobile device being used

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a mobile device for push notifications \nAllowed enum values: push

default: push

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

id

\n
\n

string

\n

Unique identifier for the channel

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "relationships": { + "channel": { + "data": {} + } + }, + "type": "notification_rules" + } + }, + "json": { + "data": { + "attributes": { + "category": "string", + "channel_settings": { + "method": "sms", + "type": "phone" + }, + "delay_minutes": "integer" + }, + "id": "string", + "relationships": { + "channel": { + "data": { + "id": "string", + "type": "notification_channels" + } + } + }, + "type": "notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for updating an on-call notification rule

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

attributes

\n
\n

object

\n

Attributes for creating or modifying an on-call notification rule.

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

category

\n
\n

enum

\n

Specifies the category a notification rule will apply to \nAllowed enum values: high_urgency,low_urgency

default: high_urgency

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

channel_settings

\n
\n

 <oneOf>

\n

Configuration for the associated channel, if necessary

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

Option 1

\n
\n

object

\n

Configuration for using a phone notification channel in a notification rule

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

method [required]

\n
\n

enum

\n

Specifies the method in which a phone is used in a notification rule \nAllowed enum values: sms,voice

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

type [required]

\n
\n

enum

\n

Indicates that the notification channel is a phone \nAllowed enum values: phone

default: phone

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

delay_minutes

\n
\n

int64

\n

The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation

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

id

\n
\n

string

\n

Unique identifier for the rule

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

relationships

\n
\n

object

\n

Relationship object for creating a notification rule

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

channel

\n
\n

object

\n

Relationship object for creating a notification rule

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

data [required]

\n
\n

object

\n

Channel relationship data for creating a notification rule

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

id

\n
\n

string

\n

ID of the notification channel

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

type

\n
\n

enum

\n

Indicates that the resource is of type 'notification_channels'. \nAllowed enum values: notification_channels

default: notification_channels

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

type [required]

\n
\n

enum

\n

Indicates that the resource is of type 'notification_rules'. \nAllowed enum values: notification_rules

default: notification_rules

\n
\n \n
\n
\n
\n
" + } } } \ No newline at end of file diff --git a/content/en/api/v2/on-call/request.CreateUserNotificationRule.json b/content/en/api/v2/on-call/request.CreateUserNotificationRule.json new file mode 100644 index 00000000000..0b54847d1ec --- /dev/null +++ b/content/en/api/v2/on-call/request.CreateUserNotificationRule.json @@ -0,0 +1,17 @@ +{ + "data": { + "attributes": { + "category": "high_urgency", + "delay_minutes": 0 + }, + "relationships": { + "channel": { + "data": { + "id": "7c1ce93f-30a5-596a-0f7b-06bfe153704c", + "type": "notification_channels" + } + } + }, + "type": "notification_rules" + } +} \ No newline at end of file diff --git a/content/en/api/v2/on-call/request.UpdateUserNotificationRule.json b/content/en/api/v2/on-call/request.UpdateUserNotificationRule.json new file mode 100644 index 00000000000..0ef543d175d --- /dev/null +++ b/content/en/api/v2/on-call/request.UpdateUserNotificationRule.json @@ -0,0 +1,18 @@ +{ + "data": { + "attributes": { + "category": "high_urgency", + "delay_minutes": 1 + }, + "id": "4d00de6b-e1c1-e5fa-b238-57acec728d0d", + "relationships": { + "channel": { + "data": { + "id": "7c1ce93f-30a5-596a-0f7b-06bfe153704c", + "type": "notification_channels" + } + } + }, + "type": "notification_rules" + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index 6ddf4d84149..7e6713139cd 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -1244,6 +1244,13 @@ "description": "Create an On-Call notification channel for a user returns \"Created\" response" } ], + "CreateUserNotificationRule": [ + { + "group": "on-call", + "suffix": "", + "description": "Create an On-Call notification rule for a user returns \"Created\" response" + } + ], "SetOnCallTeamRoutingRules": [ { "group": "on-call", @@ -1265,6 +1272,13 @@ "description": "Update On-Call schedule returns \"OK\" response" } ], + "UpdateUserNotificationRule": [ + { + "group": "on-call", + "suffix": "", + "description": "Update an On-Call notification rule for a user returns \"OK\" response" + } + ], "CreateOpsgenieService": [ { "group": "opsgenie_integration", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 2749934bb4b..027cb2416f4 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -13281,6 +13281,40 @@ components: - name - targets type: object + CreateOnCallNotificationRuleRequest: + description: A top-level wrapper for creating a notification rule for a user + example: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + relationships: + channel: + data: + id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2 + type: notification_channels + type: notification_rules + properties: + data: + $ref: '#/components/schemas/CreateOnCallNotificationRuleRequestData' + required: + - data + type: object + CreateOnCallNotificationRuleRequestData: + description: Data for creating an on-call notification rule + properties: + attributes: + $ref: '#/components/schemas/OnCallNotificationRuleRequestAttributes' + relationships: + $ref: '#/components/schemas/OnCallNotificationRuleRelationships' + type: + $ref: '#/components/schemas/OnCallNotificationRuleType' + required: + - type + type: object CreateOpenAPIResponse: description: Response for `CreateOpenAPI` operation. properties: @@ -30833,6 +30867,18 @@ components: $ref: '#/components/schemas/NotificationChannelData' type: array type: object + ListOnCallNotificationRulesResponse: + description: Response type for listing notification rules for a user + properties: + data: + items: + $ref: '#/components/schemas/OnCallNotificationRuleData' + type: array + included: + items: + $ref: '#/components/schemas/OnCallNotificationRulesIncluded' + type: array + type: object ListPipelinesResponse: description: Represents the response payload containing a list of pipelines and associated metadata. @@ -39287,6 +39333,130 @@ components: required: - type type: object + OnCallNotificationRule: + description: A top-level wrapper for a notification rule + example: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + relationships: + channel: + data: + id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2 + type: notification_channels + type: notification_rules + properties: + data: + $ref: '#/components/schemas/OnCallNotificationRuleData' + included: + items: + $ref: '#/components/schemas/OnCallNotificationRulesIncluded' + type: array + required: + - data + type: object + OnCallNotificationRuleAttributes: + description: Attributes for an on-call notification rule. + properties: + category: + $ref: '#/components/schemas/OnCallNotificationRuleCategory' + channel_settings: + $ref: '#/components/schemas/OnCallNotificationRuleChannelSettings' + description: Configuration for the associated channel, if necessary + nullable: true + delay_minutes: + description: The number of minutes that will elapse before this rule is + evaluated. 0 indicates immediate evaluation + format: int64 + type: integer + type: object + OnCallNotificationRuleCategory: + default: high_urgency + description: Specifies the category a notification rule will apply to + enum: + - high_urgency + - low_urgency + type: string + x-enum-varnames: + - HIGH_URGENCY + - LOW_URGENCY + OnCallNotificationRuleChannelRelationship: + description: Relationship object for creating a notification rule + properties: + data: + $ref: '#/components/schemas/OnCallNotificationRuleChannelRelationshipData' + required: + - data + type: object + OnCallNotificationRuleChannelRelationshipData: + description: Channel relationship data for creating a notification rule + properties: + id: + description: ID of the notification channel + type: string + type: + $ref: '#/components/schemas/NotificationChannelType' + type: object + OnCallNotificationRuleChannelSettings: + description: Defines the configuration for a channel associated with a notification + rule + oneOf: + - $ref: '#/components/schemas/OnCallPhoneNotificationRuleSettings' + OnCallNotificationRuleData: + description: Data for an on-call notification rule + properties: + attributes: + $ref: '#/components/schemas/OnCallNotificationRuleAttributes' + id: + description: Unique identifier for the rule + type: string + relationships: + $ref: '#/components/schemas/OnCallNotificationRuleRelationships' + type: + $ref: '#/components/schemas/OnCallNotificationRuleType' + required: + - type + type: object + OnCallNotificationRuleRelationships: + description: Relationship object for creating a notification rule + properties: + channel: + $ref: '#/components/schemas/OnCallNotificationRuleChannelRelationship' + type: object + OnCallNotificationRuleRequestAttributes: + description: Attributes for creating or modifying an on-call notification rule. + properties: + category: + $ref: '#/components/schemas/OnCallNotificationRuleCategory' + channel_settings: + $ref: '#/components/schemas/OnCallNotificationRuleChannelSettings' + description: Configuration for the associated channel, if necessary + nullable: true + delay_minutes: + description: The number of minutes that will elapse before this rule is + evaluated. 0 indicates immediate evaluation + format: int64 + type: integer + type: object + OnCallNotificationRuleType: + default: notification_rules + description: Indicates that the resource is of type 'notification_rules'. + enum: + - notification_rules + example: notification_rules + type: string + x-enum-varnames: + - NOTIFICATION_RULES + OnCallNotificationRulesIncluded: + description: Represents additional included resources for a on-call notification + rules + oneOf: + - $ref: '#/components/schemas/NotificationChannelData' OnCallPageTargetType: description: The kind of target, `team_id` | `team_handle` | `user_id`. enum: @@ -39299,6 +39469,29 @@ components: - TEAM_ID - TEAM_HANDLE - USER_ID + OnCallPhoneNotificationRuleMethod: + description: Specifies the method in which a phone is used in a notification + rule + enum: + - sms + - voice + example: sms + type: string + x-enum-varnames: + - SMS + - VOICE + OnCallPhoneNotificationRuleSettings: + description: Configuration for using a phone notification channel in a notification + rule + properties: + method: + $ref: '#/components/schemas/OnCallPhoneNotificationRuleMethod' + type: + $ref: '#/components/schemas/NotificationChannelPhoneConfigType' + required: + - type + - method + type: object OnDemandConcurrencyCap: description: On-demand concurrency cap. properties: @@ -56538,6 +56731,59 @@ components: - name - options type: object + UpdateOnCallNotificationRuleRequest: + description: A top-level wrapper for updating a notification rule for a user + example: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + id: 2462ace1-49e2-aab1-xc4f-29cc4ae1105n7 + relationships: + channel: + data: + id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2 + type: notification_channels + type: notification_rules + properties: + data: + $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequestData' + required: + - data + type: object + UpdateOnCallNotificationRuleRequestAttributes: + description: Attributes for creating or modifying an on-call notification rule. + properties: + category: + $ref: '#/components/schemas/OnCallNotificationRuleCategory' + channel_settings: + $ref: '#/components/schemas/OnCallNotificationRuleChannelSettings' + description: Configuration for the associated channel, if necessary + nullable: true + delay_minutes: + description: The number of minutes that will elapse before this rule is + evaluated. 0 indicates immediate evaluation + format: int64 + type: integer + type: object + UpdateOnCallNotificationRuleRequestData: + description: Data for updating an on-call notification rule + properties: + attributes: + $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequestAttributes' + id: + description: Unique identifier for the rule + type: string + relationships: + $ref: '#/components/schemas/OnCallNotificationRuleRelationships' + type: + $ref: '#/components/schemas/OnCallNotificationRuleType' + required: + - type + type: object UpdateOpenAPIResponse: description: Response for `UpdateOpenAPI`. properties: @@ -76824,6 +77070,260 @@ paths: operator: AND permissions: - on_call_read + /api/v2/on-call/users/{user_id}/notification-rules: + get: + description: List the notification rules for a user. The authenticated user + must be the target user or have the `on_call_admin` permission + operationId: ListUserNotificationRules + parameters: + - description: 'Comma-separated list of included relationships to be returned. + Allowed values: `channel`.' + in: query + name: include + schema: + type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListOnCallNotificationRulesResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: List On-Call notification rules for a user + tags: + - On-Call + x-menu-order: 18 + x-permission: + operator: AND + permissions: + - on_call_read + post: + description: Create a new notification rule for a user. The authenticated user + must be the target user or have the `on_call_admin` permission + operationId: CreateUserNotificationRule + parameters: + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateOnCallNotificationRuleRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OnCallNotificationRule' + description: Created + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Create an On-Call notification rule for a user + tags: + - On-Call + x-menu-order: 17 + x-permission: + operator: AND + permissions: + - on_call_respond + /api/v2/on-call/users/{user_id}/notification-rules/{rule_id}: + delete: + description: Delete a notification rule for a user. The authenticated user must + be the target user or have the `on_call_admin` permission + operationId: DeleteUserNotificationRule + parameters: + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: The rule ID + in: path + name: rule_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Delete an On-Call notification rule for a user + tags: + - On-Call + x-menu-order: 19 + x-permission: + operator: OR + permissions: + - on_call_respond + get: + description: Get a notification rule for a user. The authenticated user must + be the target user or have the `on_call_admin` permission + operationId: GetUserNotificationRule + parameters: + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: The rule ID + in: path + name: rule_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: 'Comma-separated list of included relationships to be returned. + Allowed values: `channel`.' + in: query + name: include + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OnCallNotificationRule' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Get an On-Call notification rule for a user + tags: + - On-Call + x-menu-order: 20 + x-permission: + operator: OR + permissions: + - on_call_read + put: + description: Update a notification rule for a user. The authenticated user must + be the target user or have the `on_call_admin` permission + operationId: UpdateUserNotificationRule + parameters: + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: The rule ID + in: path + name: rule_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: 'Comma-separated list of included relationships to be returned. + Allowed values: `channel`.' + in: query + name: include + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OnCallNotificationRule' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Update an On-Call notification rule for a user + tags: + - On-Call + x-menu-order: 21 + x-permission: + operator: OR + permissions: + - on_call_read /api/v2/org_configs: get: description: Returns all Org Configs (name, description, and value). diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index aff4c58128d..573136ceecd 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -2029,6 +2029,30 @@ "description": "Get a notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission", "summary": "Get an On-Call notification channel for a user" }, + "ListUserNotificationRules": { + "description": "List the notification rules for a user. The authenticated user must be the target user or have the `on_call_admin` permission", + "summary": "List On-Call notification rules for a user" + }, + "CreateUserNotificationRule": { + "description": "Create a new notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission", + "summary": "Create an On-Call notification rule for a user", + "request_description": "", + "request_schema_description": "A top-level wrapper for creating a notification rule for a user" + }, + "DeleteUserNotificationRule": { + "description": "Delete a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission", + "summary": "Delete an On-Call notification rule for a user" + }, + "GetUserNotificationRule": { + "description": "Get a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission", + "summary": "Get an On-Call notification rule for a user" + }, + "UpdateUserNotificationRule": { + "description": "Update a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission", + "summary": "Update an On-Call notification rule for a user", + "request_description": "", + "request_schema_description": "A top-level wrapper for updating a notification rule for a user" + }, "ListOrgConfigs": { "description": "Returns all Org Configs (name, description, and value).", "summary": "List Org Configs"