Add Search Based Alert Config
DescriptionAdd a new Search Based Alert Configuration (User Defined Alert Configuration).
Request
URLURL
Request Body
Add a new Search Based Alert Configuration
{
"alert_name": "string",
"alert_type": "PROBLEM",
"generate_alert_criteria": "SEARCH_RESULT_CHANGE",
"notification_settings": [
{
"frequency": "IMMEDIATE",
"notification_time": "string",
"receivers": [
"string"
],
"type": "EMAIL"
}
],
"search_criteria": "string",
"severity": "Critical"
}
Name of the Search based Alert Configuration.
The type of alert. It can take a value PROBLEM or CHANGE.
Possible values are: PROBLEM , CHANGE
The basis of raising of alerts. It can take a value SEARCH_RESULT_CHANGE or ZERO_SEARCH_RESULTS
Possible values are: SEARCH_RESULT_CHANGE , ZERO_SEARCH_RESULTS
Notifications configured for alerts corresponding to this alert configuration.
The search query for the search-based alert configuration.
Authentication
Response
Response BodyResponse Body
201 Created
{
"alert_name": "string",
"alert_type": "PROBLEM",
"enabled": false,
"entity_id": "string",
"generate_alert_criteria": "SEARCH_RESULT_CHANGE",
"notification_settings": [
{
"frequency": "IMMEDIATE",
"notification_time": "string",
"receivers": [
"string"
],
"type": "EMAIL"
}
],
"search_criteria": "string",
"severity": "Critical"
}
Name of the Search based Alert Configuration.
The type of alert. It can take a value PROBLEM or CHANGE.
Possible values are: PROBLEM , CHANGE
Boolean value to depict if the Search based alert configuration is enabled.
The basis of raising of alerts. It can take a value SEARCH_RESULT_CHANGE or ZERO_SEARCH_RESULTS
Possible values are: SEARCH_RESULT_CHANGE , ZERO_SEARCH_RESULTS
Notifications configured for alerts corresponding to this alert configuration.
The search query for the search-based alert configuration.
Errors
Bad Request
Unauthorized
Forbidden
Internal Error
