NotificationChannels

Notification Channels are the medium through which notifications are sent.

Get supported Notification Channels

Get supported Notification Channels

SecuritybearerAuth
Responses
200

Notification Channel types

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

get/api/v1/notification-channels
Response samples
applicatin/json
[
  • {
    }
]

Create configuration of notification channel

Create configuration of notification channel

SecuritybearerAuth
Request
Request Body schema: application/json
type
required
string (NotificationChannelType)
Default: "email"
Value: "email"
required
object (NotificationChannelConfig)
name
required
string
Responses
200

Notification channel config

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

409

The specified resource already exists

500

unexpected error

501

unexpected error

503

unexpected error

post/api/v1/notification-channels
Request samples
application/json
{
  • "type": "email",
  • "config": {
    },
  • "name": "string"
}
Response samples
application/json
{
  • "type": "email",
  • "config": {
    },
  • "name": "string"
}

Get configuration of notification channel

Get configuration of notification channel

SecuritybearerAuth
Request
path Parameters
name
required
string

Notification Channel name

Responses
200

Notification channel config

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

get/api/v1/notification-channels/{name}
Response samples
application/json
{
  • "type": "email",
  • "config": {
    },
  • "name": "string"
}

Patch configuration of Notification Channel

Patch configuration of Notification Channel

SecuritybearerAuth
Request
path Parameters
name
required
string

Notification Channel name

Request Body schema: application/json
type
string (NotificationChannelType)
Default: "email"
Value: "email"
object (NotificationChannelConfig)
Responses
200

Notification Channel config

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

patch/api/v1/notification-channels/{name}
Request samples
application/json
{
  • "type": "email",
  • "config": {
    }
}
Response samples
application/json
{
  • "type": "email",
  • "config": {
    },
  • "name": "string"
}

Update configuration of Notification Channel

Update configuration of Notification Channel

SecuritybearerAuth
Request
path Parameters
name
required
string

Notification Channel name

Request Body schema: application/json
type
required
string (NotificationChannelType)
Default: "email"
Value: "email"
required
object (NotificationChannelConfig)
name
required
string
Responses
200

Notification Channel config

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

put/api/v1/notification-channels/{name}
Request samples
application/json
{
  • "type": "email",
  • "config": {
    },
  • "name": "string"
}
Response samples
application/json
{
  • "type": "email",
  • "config": {
    },
  • "name": "string"
}

Delete configuration of Notification Channel

Delete configuration of Notification Channel

SecuritybearerAuth
Request
path Parameters
name
required
string

Notification Channel name

Responses
204

The resource was deleted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

delete/api/v1/notification-channels/{name}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Validate configuration of Notification Channel

Validate configuration of Notification Channel

SecuritybearerAuth
Request
Request Body schema: application/json
type
required
string (NotificationChannelType)
Default: "email"
Value: "email"
required
object (NotificationChannelConfig)
Responses
200

Notification Channel validity

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

409

The specified resource already exists

500

unexpected error

501

unexpected error

503

unexpected error

post/api/v1/validate-notification-channel
Request samples
application/json
{
  • "type": "email",
  • "config": {
    }
}
Response samples
application/json
true