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

Get All Search Based Alert Configs

Description

List all Search Based Alert Configurations (User Defined Alert Configurations).

Request

Request

URL

URL


get
https://vrni.example.com/api/ni/settings/alerts/search-based-alerts
Copy

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SearchBasedAlertConfigListResponse of type(s) application/json
{
	"results": [
		{
			"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"
		}
	],
	"total_count": 0
}
results Optional

integer
total_count Optional
Errors

Errors

ApiError
400

Bad Request


ApiError
401

Unauthorized


ApiError
403

Forbidden


ApiError
404

Not Found


500

Internal Error

Code Samples

Code Samples

cURL Command

curl https://vrni.example.com/api/ni/settings/alerts/search-based-alerts


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

Was this page helpful?