[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Update Search Based Alert Config

Description

Update an existing Search Based Alert Configuration (User Defined Alert Configuration).

Request

Request

URL

URL


put
https://vrni.example.com/api/ni/settings/alerts/search-based-alerts/{id}
Copy

Path Parameters

Path Parameters

string
id Required

The Entity ID of object requestion information on


Request Body

Request Body

SearchBasedAlertConfigRequest of type(s) application/json Required

Update an existing User-Defined event.

{
	"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"
}
string
alert_name Optional

Name of the Search based Alert Configuration.


alert_type Optional

The type of alert. It can take a value PROBLEM or CHANGE.

Possible values are: PROBLEMCHANGE


generate_alert_criteria Optional

The basis of raising of alerts. It can take a value SEARCH_RESULT_CHANGE or ZERO_SEARCH_RESULTS

Possible values are: SEARCH_RESULT_CHANGEZERO_SEARCH_RESULTS


notification_settings Optional

Notifications configured for alerts corresponding to this alert configuration.


string
search_criteria Optional

The search query for the search-based alert configuration.


severity Optional

Possible values are: CriticalModerateWarningInfo

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SearchBasedAlertConfigResponse of type(s) application/json
{
	"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"
}
string
alert_name Optional

Name of the Search based Alert Configuration.


alert_type Optional

The type of alert. It can take a value PROBLEM or CHANGE.

Possible values are: PROBLEMCHANGE


boolean
enabled Optional

Boolean value to depict if the Search based alert configuration is enabled.


string
entity_id Optional

generate_alert_criteria Optional

The basis of raising of alerts. It can take a value SEARCH_RESULT_CHANGE or ZERO_SEARCH_RESULTS

Possible values are: SEARCH_RESULT_CHANGEZERO_SEARCH_RESULTS


notification_settings Optional

Notifications configured for alerts corresponding to this alert configuration.


string
search_criteria Optional

The search query for the search-based alert configuration.


severity Optional

Possible values are: CriticalModerateWarningInfo

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"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"}' https://vrni.example.com/api/ni/settings/alerts/search-based-alerts/{id}


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Settings Operations
Feedback

Was this page helpful?