NotificationChannels

Notification Channels are the medium through which notifications are sent.

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

application/json

[{"name": "my-email",
"type": "email"
}
]

Create notification channel

SecuritybearerAuth

Request

Request Body schema: application/json

type required	string (NotificationChannelType) Default: "email" Enum: "email" "slack"
required	object (NotificationChannelConfig)

Responses

200

Notification channel created

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

Payload

application/json

{"type": "email",
"config": {"username": "email@gmail.com",
"password": 123456,
"smtpHost": "smtp.gmail.com",
"from": "email@gmail.com",
"subject": "My subject"
}
}

Response samples

application/json

{"code": 400,
"message": "Required parameter is missing"
}

Get notification channel

SecuritybearerAuth

Request

path Parameters

name

required

string [ 1 .. 250 ] characters

Notification Channel name

Responses

200

Notification channel

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": {"username": "email@gmail.com",
"password": 123456,
"smtpHost": "smtp.gmail.com",
"from": "email@gmail.com",
"subject": "My subject"
},
"name": "string"
}

Patch notification channel

SecuritybearerAuth

Request

path Parameters

name

required

string [ 1 .. 250 ] characters

Notification Channel name

Request Body schema: application/json

type	string (NotificationChannelType) Default: "email" Enum: "email" "slack"
	object (NotificationChannelConfig)

Responses

200

Notification channel patched

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

Payload

application/json

{"type": "email",
"config": {"username": "email@gmail.com",
"password": 123456,
"smtpHost": "smtp.gmail.com",
"from": "email@gmail.com",
"subject": "My subject"
}
}

Response samples

application/json

{"code": 400,
"message": "Required parameter is missing"
}

Update notification channel

SecuritybearerAuth

Request

path Parameters

name

required

string [ 1 .. 250 ] characters

Notification Channel name

Request Body schema: application/json

type required	string (NotificationChannelType) Default: "email" Enum: "email" "slack"
required	object (NotificationChannelConfig)

Responses

200

Notification channel updated

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

Payload

application/json

{"type": "email",
"config": {"username": "email@gmail.com",
"password": 123456,
"smtpHost": "smtp.gmail.com",
"from": "email@gmail.com",
"subject": "My subject"
}
}

Response samples

application/json

{"code": 400,
"message": "Required parameter is missing"
}

Delete notification channel

SecuritybearerAuth

Request

path Parameters

name

required

string [ 1 .. 250 ] characters

Notification Channel name

Responses

204

Notification channel deleted

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

SecuritybearerAuth

Request

Request Body schema: application/json

type required	string (NotificationChannelType) Default: "email" Enum: "email" "slack"
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

Payload

application/json

{"type": "email",
"config": {"username": "email@gmail.com",
"password": 123456,
"smtpHost": "smtp.gmail.com",
"from": "email@gmail.com",
"subject": "My subject"
}
}

Response samples

application/json

true