Create a notification channel

Beta Create a new notification channel, to set up a communication method for a monitoring alert. This is referred to as a user channel and you can have a maximum of five on your account.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: monitor:read_write

CLI

linode-cli alerts channels-create --label Email channel for Managed Database alerts \ --channel_type email \ --details.email.usernames johndoe \ --details.email.usernames janedoe

Learn more

Path Params
string
enum
required

Enum Call the v4beta URL for operations still only in beta.

Allowed:
Body Params
string
enum
required

The type of notification used with the notification channel. Currently, only email is supported.

Allowed:
details
object
required

The configuration of the notification channel. Currently, only email is supported for use in a notification channel.

string

The name of the notification channel for identification purposes. This value needs to be unique for each notification channel.

Responses

Response body
object
alerts
object

Details about the alerts where you've applied this notification channel.

integer

The number of alerts that have been assigned to this notification channel. This will be 0 for a newly created channel.

string
enum

The alert's entity type. This will always be alert-definitions for an alert.

alert-definitions

url

The URL to access a list of all of the alerts assigned to this notification channel, based on its id.

string
enum

The type of notification used with the channel. Currently, only email is supported.

email

date-time

When the notification channel was created.

string

For a user notification channel, this is the user on your account that created it. For a system notification channel, this value is returned as system.

details
object

The configuration of the notification channel.

email
object

A notification channel set up to deliver an email for an alert.

integer

Filterable The unique identifier for the notification channel.

string

Filterable The name of the notification channel for identification purposes.

string
enum

The type of notification channel. This can be either system for a channel provided by Akamai, or user for one you've created.

system user

date-time

When the notification channel was last updated. This is the same as created if the channel hasn't been updated.

string

For a user notification channel, this is the user on your account that last updated it. For a system notification channel, this is returned as system. If it hasn't been updated, this value is the same as created_by.

Language
Credentials
Original text
Rate this translation
Your feedback will be used to help improve Google Translate