VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
vRealize Network Insight API Reference Settings

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
EmailFrequency Enum
email_frequency Optional

Possible values are: IMMEDIATELY , DAILY_DIGEST

array of string
email_ids Optional
string
event_name Optional
GenerateEventCritera Enum
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_CHANGE , ZERO_SEARCH_RESULTS

boolean
is_problem Optional
array of NotificationSetting
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.

ApiKeyAuth

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
EmailFrequency Enum
email_frequency Optional

Possible values are: IMMEDIATELY , DAILY_DIGEST

array of string
email_ids Optional
string
entity_id Optional
string
event_name Optional
GenerateEventCritera Enum
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_CHANGE , ZERO_SEARCH_RESULTS

boolean
is_problem Optional
array of NotificationSetting
notification_settings Optional

Notifications configured for alerts corresponding to this alert configuration.
string
search_criteria Optional
Severity Enum
severity Optional

Possible values are: Critical , Moderate , Warning , Info

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 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}

Generated on: 09 Jun 23 08:12 UTC
[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
On This Page
Settings Operations
post
Activate Serial Number
post
Add Backup Config
post
Add IP Tag
post
Add New SNMP Trap Destination Profile
post
Add Restore Config
post
Add Search Based Alert Config
post
Add VIdm User
post
Add VIdm User Group
post
Add Web Proxy
post
Create Subnet Mapping
post
Create Subscriber
post
Create User Defined Event
delete
Deactivate Serial Number
delete
Delete An Existing SNMP Trap Destination Profile
delete
Delete Backup Config
delete
Delete Restore Config
delete
Delete Search Based Alert Config
delete
Delete Subnet Mapping
delete
Delete Subscriber
delete
Delete User
delete
Delete User Defined Event
delete
Delete User Group
delete
Delete VIdm Configuration
delete
Delete Web Proxy
post
Disable Search Based Alert Config
post
Disable User Defined Event
post
Disable VIdm
post
Enable Search Based Alert Config
post
Enable User Defined Event
post
Enable VIdm
get
Get All Search Based Alert Configs
get
Get All Subscriber
get
Get All User Defined Events
get
Get Backup Config
get
Get Backup Status Report
get
Get Certificate
get
Get Connected Clients To Web Proxy
get
Get Details Of An Existing SNMP Destination Profile
get
Get IP Tag
get
Get IP Tag Ids
get
Get Infra Nodes Web Proxy
get
Get Licenses
get
Get Restore Config
get
Get Restore Status Report
get
Get Search Based Alert Config
get
Get Subnet Mappings
get
Get Subscriber
get
Get User
get
Get User Defined Event
get
Get User Group
get
Get User Groups
get
Get Users
get
Get VIdm Configuration
get
Get Web Proxies
get
Get Web Proxy
get
List The Configured SNMP Trap Destination Profiles
post
Migrate Event Subscriptions To Other SNMP Trap Destination Profiles
post
Remove IP Tag
post
Save VIdm Configuration
post
Send Test Trap To SNMP Destination Profile
put
Update An Existing SNMP Destination Profile
put
Update Backup Config
put
Update Search Based Alert Config
put
Update Subnet Mapping
put
Update Subscriber
put
Update User Defined Event
put
Update User Password
put
Update VIdm Configuration
put
Update VIdm User Group Role
put
Update VIdm User Role
put
Update Web Proxy
post
Validate Connections via Web Proxy
post
Validate Serial Number
post
Validate Web Proxy Migration
Feedback

Was this page helpful?

© 2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us