Basic Parameters
| Parameter | Description |
|---|---|
| Category | Category of the alert. |
| Description | Description of the alert. |
| Email Targets | A comma-separated list of configured email targets to send alert notification to. |
| ID | The ID of the alert to update. |
| Is Muted | Mute/Unmute the alert. |
| Name | Name of the alert. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Interval | Triggering the alert at the numeric interval. |
| Interval Unit | The unit used for the numeric interval parameter (either “minute” or “hour”). |
| Is Enabled | Enable/Disable the alert. |
| Severity | Severity of the alert. |
| Sms Targets | A comma-separated list of configured SMS targets to send alert notification to. |
| Subcategory | Sub category is the template name of the alert. |
| Threshold | Triggering the alert when reaching the specified numeric threshold value. |
Example Output
{
"_links": {
"self": {
"href": "https://ec2-34-245-196-188.eu-west-1.compute.amazonaws.com/api/alert?calculate_count=false&offset=0&limit=25&sort=%2Bid&filter=%7B%7D"
},
"first": {
"href": "https://ec2-34-245-196-188.eu-west-1.compute.amazonaws.com/api/alert?calculate_count=false&offset=0&limit=25&sort=%2Bid&filter=%7B%7D"
}
},
"_embedded": {
"items": [
{
"id": 1,
"name": "User WatchList",
"description": "List of users who are monitored for authentication failures",
"category": "WatchList",
"subcategory": "User WatchList",
"email_targets": [],
"sms_targets": [],
"config": {
"filter": {}
},
"severity": "warning",
"threshold": 1,
"interval": 5,
"interval_unit": "minute",
"is_enabled": false,
"is_muted": false,
"_links": {
"self": {
"href": "https://ec2-34-245-196-188.eu-west-1.compute.amazonaws.com/api/alert/1"
}
}
}
]
}
}