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

Update User Defined Event Deprecated

Description

Update an existing User-Defined event.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

The Entity ID of object requestion information on


Request Body

Request Body

SubscriptionRequest of type(s) application/json Required

Update an existing User-Defined event.

{
	"daily_at_utc": "string",
	"email_frequency": "IMMEDIATELY",
	"email_ids": [
		"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": "string",
	"snmp_trap_entity_ids": [
		"string"
	]
}
string
daily_at_utc Optional

email_frequency Optional

Possible values are: IMMEDIATELYDAILY_DIGEST


array of string
email_ids 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

string
severity Optional

array of string
snmp_trap_entity_ids Optional
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

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 '{"daily_at_utc":"string","email_frequency":"IMMEDIATELY","email_ids":["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":"string","snmp_trap_entity_ids":["string"]}' https://vrni.example.com/api/ni/settings/events/user-defined-events/{id}


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

Was this page helpful?