NotificationChannels

Notification Channels are the medium through which notifications are sent.

Get supported Notification Channels

get

Get supported Notification Channels

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

Notification Channel types

application/json
get
/api/v1/notification-channels

Create notification channel

post

Create notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
chevron-right
200

Notification channel created

No content

post
/api/v1/notification-channels

No content

Get notification channel

get

Get notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestring · min: 1 · max: 250Required

Notification Channel name

Responses
chevron-right
200

Notification channel

application/json
get
/api/v1/notification-channels/{name}

Update notification channel

put

Update notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestring · min: 1 · max: 250Required

Notification Channel name

Body
Responses
chevron-right
200

Notification channel updated

No content

put
/api/v1/notification-channels/{name}

No content

Delete notification channel

delete

Delete notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestring · min: 1 · max: 250Required

Notification Channel name

Responses
delete
/api/v1/notification-channels/{name}

No content

Patch notification channel

patch

Patch notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestring · min: 1 · max: 250Required

Notification Channel name

Body
typestring · enumOptionalDefault: emailPossible values:
Responses
chevron-right
200

Notification channel patched

No content

patch
/api/v1/notification-channels/{name}

No content

Validate configuration of Notification Channel

post

Validate configuration of Notification Channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
chevron-right
200

Notification Channel validity

application/json
ResponsebooleanExample: true
post
/api/v1/validate-notification-channel

Last updated