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

Enable User Defined Event Deprecated

Description

Enable an existing User-Defined event.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/settings/events/user-defined-events/{id}/enable
Copy

Path Parameters

Path Parameters

string
id Required

The Entity ID of object requestion information on


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SubscriptionResponse of type(s) application/json
{
	"active": false,
	"daily_at_utc": "string",
	"email_frequency": "IMMEDIATELY",
	"email_ids": [
		"string"
	],
	"entity_id": "string",
	"event_name": "string",
	"generate_event_criteria": "SEARCH_RESULT_CHANGE",
	"is_problem": false,
	"notification_settings": [
		{
			"frequency": "IMMEDIATE",
			"notification_time": "string",
			"receivers": [
				"string"
			],
			"type": "EMAIL"
		}
	],
	"search_criteria": "string",
	"severity": "Critical",
	"snmp_trap_entity_ids": [
		"string"
	]
}
boolean
active Optional

string
daily_at_utc Optional

email_frequency Optional

Possible values are: IMMEDIATELYDAILY_DIGEST


array of string
email_ids Optional

string
entity_id Optional

string
event_name Optional

generate_event_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


boolean
is_problem Optional

notification_settings Optional

Notifications configured for alerts corresponding to this alert configuration.


string
search_criteria Optional

severity Optional

Possible values are: CriticalModerateWarningInfo


array of string
snmp_trap_entity_ids 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 -X POST https://vrni.example.com/api/ni/settings/events/user-defined-events/{id}/enable


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

Was this page helpful?