Alert Policies
APIs to manage Alert Policies
Tenant Id can be retrieved from the UI as listed here
Currently supported alert policy metric_type and condition are listed here
List all alert policies for specific tenant and source
GET
https://demo.backend.telm.ai/<tenant>/configuration/sources/<source>/alert_policies
Path Parameters
Name | Type | Description |
---|---|---|
tenant* | String | Tenant Id |
source* | String | Source Id |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer {token} |
Add a new alert policy
POST
https://demo.backend.telm.ai/{tenant}/configuration/sources/{source}/alert_policies
Path Parameters
Name | Type | Description |
---|---|---|
tenant* | String | Tenant Id |
source* | String | Source Id |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer <token> |
Request Body
Name | Type | Description |
---|---|---|
name* | String | Name of the alert policy |
attributes* | Array | List of attributes to alert on |
condition* | String | Supported list of condition listed here |
threshold* | Number | Number between 0 and 1 (percentage of deviation) |
description | String | Description of this policy |
metric_type* | String | Supported list of metric_type listed here |
channel_name | String | Alert channel for this policy |
send_notifications | Boolean | true or false |
Get details of an existing alert policy
GET
https://demo.backend.telm.ai/{tenant}/configuration/sources/{source}/alert_policies/{alert_policy_name}
Path Parameters
Name | Type | Description |
---|---|---|
tenant* | String | Tenant Id |
alert_policy_name* | String | Name of the alert policy |
source* | String | Source Id |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer {token} |
Update an existing alert policy
PUT
https://demo.backend.telm.ai/{tenant}/configuration/sources/{source}/alert_policies/{alert_policy_name}
Path Parameters
Name | Type | Description |
---|---|---|
tenant* | String | Tenant Id |
alert_channel_name* | String | Name of the alert channel to update |
source* | String | Source Id |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer {token} |
Request Body
Name | Type | Description |
---|---|---|
name | String | Updated name of policy |
attributes* | Array | Updated or original list of attributes |
condition* | String | Supported list of condition listed here |
threshold* | Number | |
description | String | Updated description |
metric_type* | String | Supported list of metric_type listed here |
channel_name | String | Alert channel for this policy |
send_notifications | Boolean | true or false |
Delete an alert policy
DELETE
https://demo.backend.telm.ai/{tenant}/configuration/sources/{source}/alert_policies/{alert_policy_name}
Path Parameters
Name | Type | Description |
---|---|---|
tenant* | String | Tenant id |
alert_policy_name* | String | Name of alert channel to delete |
source* | String | Source Id |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer {token} |
Prebuilt Alert Policies
List all prebuilt policies for this tenant and source
GET
https://demo.backend.telm.ai/{tenant}/configuration/sources/{source}/prebuilt_policies
Path Parameters
Name | Type | Description |
---|---|---|
tenant* | String | Tenant Id |
source* | String | Source Id |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer {token} |
Details of prebuilt policy by name
GET
https://demo.backend.telm.ai/{tenant}/configuration/sources/{source}/prebuilt_policies/{policy_name}
Path Parameters
Name | Type | Description |
---|---|---|
tenant* | String | Tenant Id |
source* | String | Source Id |
policy_name* | String | Name of policy |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer {token} |
Update a prebuilt policy
PUT
https://demo.backend.telm.ai/{tenant}/configuration/sources/{source}/prebuilt_policies/{policy_name}
Path Parameters
Name | Type | Description |
---|---|---|
tenant* | String | Tenant Id |
source* | String | Source Id |
policy_name* | String | Name of policy |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer {token} |
Request Body
Name | Type | Description |
---|---|---|
attributes* | List | Comma separated list of attribute values |
channel_name* | String | Alert channel name |
send_notifications* | Boolean | true or false |
Last updated