Alert Channel

APIs to manage Alert Channels

Tenant Id can be retrieved from the UI as listed here

List all alert channels

GET https://demo.backend.telm.ai/{tenant}/configuration/alert_channels

Path Parameters

Name	Type	Description
tenant*	String	Tenant

Headers

Name	Type	Description
Authorization*	String	Bearer {token}

200: OK List of Alert Channels

[
    {
        "name": "<channel-name>",
        "type": "<channel-type>",
        "addresses": [
            "<recepient-email>"
        ]
    }
]

Add a new alert channel

POST https://demo.backend.telm.ai/{tenant}/configuration/alert_channels

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id

Headers

Name	Type	Description
Authorization*	String	Bearer <token>

Request Body

Name	Type	Description
name*	String	Name of the alert channel
type*	String	Type of Alert channel. Supported alert channels listed here
addresses*	Array	Comma separated list of email address

200: OK Json object of the new alert channel created

{
    "name": "<name>",
    "type": "<type>",
    "addresses": [
        "<email1>",
        "<email2>"
    ]
}

Get details of an existing alert channel

GET https://demo.backend.telm.ai/{tenant}/configuration/alert_channels/{alert_channel_name}

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id
alert_channel_name*	String	Name of the alert channel

Headers

Name	Type	Description
Authorization*	String	Bearer {token}

200: OK Details of the channel

{
    "name": "<name>",
    "type": "<type>",
    "addresses": [
        "<emails>"
    ]
}

Update an existing alert channel

PUT https://demo.backend.telm.ai/{tenant}/configuration/alert_channels//{alert_channel_name}

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id
alert_channel_name*	String	Name of the alert channel to update

Headers

Name	Type	Description
Authorization*	String	Bearer {token}

Request Body

Name	Type	Description
type*	String	Updated or original type of channel
addresses*	Json	Updated comma separated list of email addresses

200: OK Updated alert channel object

{
    "name": "<name>",
    "type": "<type>",
    "addresses": [
        "<emails>"
    ]
}

Delete an alert channel

DELETE https://demo.backend.telm.ai/{tenant}/configuration/alert_channels//{alert_channel_name}

Path Parameters

Name	Type	Description
tenant*	String	Tenant id
alert_channel_name*	String	Name of alert channel to delete

Headers

Name	Type	Description
Authorization*	String	Bearer {token}

200: OK Success message

{
    "message": "Alert channel successfully deleted"
}