VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
VMware Sase Platform API VMware SD-WAN Orchestration API v2 Monitor Events

Get Enterprise Events

Description

Fetch time-ordered list of events

Request

Request

URL

URL

get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/events
Copy
Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise

Query Parameters

Query Parameters

string
detail[contains] Optional

Filter by detail[contains]
string
detail[endsWith] Optional

Filter by detail[endsWith]
string
detail[in] Optional

Filter by detail[in]
string
detail[isNotNull] Optional

Filter by detail[isNotNull]
string
detail[isNot] Optional

Filter by detail[isNot]
string
detail[isNull] Optional

Filter by detail[isNull]
string
detail[is] Optional

Filter by detail[is]
string
detail[notContains] Optional

Filter by detail[notContains]
string
detail[notEndsWith] Optional

Filter by detail[notEndsWith]
string
detail[notIn] Optional

Filter by detail[notIn]
string
detail[notStartsWith] Optional

Filter by detail[notStartsWith]
string
detail[startsWith] Optional

Filter by detail[startsWith]
string
edgeName[contains] Optional

Filter by edgeName[contains]
string
edgeName[endsWith] Optional

Filter by edgeName[endsWith]
string
edgeName[in] Optional

Filter by edgeName[in]
string
edgeName[isNotNull] Optional

Filter by edgeName[isNotNull]
string
edgeName[isNot] Optional

Filter by edgeName[isNot]
string
edgeName[isNull] Optional

Filter by edgeName[isNull]
string
edgeName[is] Optional

Filter by edgeName[is]
string
edgeName[notContains] Optional

Filter by edgeName[notContains]
string
edgeName[notEndsWith] Optional

Filter by edgeName[notEndsWith]
string
edgeName[notIn] Optional

Filter by edgeName[notIn]
string
edgeName[notStartsWith] Optional

Filter by edgeName[notStartsWith]
string
edgeName[startsWith] Optional

Filter by edgeName[startsWith]
integer
end Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.
string
enterpriseUsername[contains] Optional

Filter by enterpriseUsername[contains]
string
enterpriseUsername[endsWith] Optional

Filter by enterpriseUsername[endsWith]
string
enterpriseUsername[in] Optional

Filter by enterpriseUsername[in]
string
enterpriseUsername[isNotNull] Optional

Filter by enterpriseUsername[isNotNull]
string
enterpriseUsername[isNot] Optional

Filter by enterpriseUsername[isNot]
string
enterpriseUsername[isNull] Optional

Filter by enterpriseUsername[isNull]
string
enterpriseUsername[is] Optional

Filter by enterpriseUsername[is]
string
enterpriseUsername[notContains] Optional

Filter by enterpriseUsername[notContains]
string
enterpriseUsername[notEndsWith] Optional

Filter by enterpriseUsername[notEndsWith]
string
enterpriseUsername[notIn] Optional

Filter by enterpriseUsername[notIn]
string
enterpriseUsername[notStartsWith] Optional

Filter by enterpriseUsername[notStartsWith]
string
enterpriseUsername[startsWith] Optional

Filter by enterpriseUsername[startsWith]
string
event[in] Optional

Filter by event[in]
string
event[isNot] Optional

Filter by event[isNot]
string
event[is] Optional

Filter by event[is]
string
event[notIn] Optional

Filter by event[notIn]
string
include Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
integer
limit Optional

Limits the maximum size of the result set.
string
message[contains] Optional

Filter by message[contains]
string
message[endsWith] Optional

Filter by message[endsWith]
string
message[in] Optional

Filter by message[in]
string
message[isNotNull] Optional

Filter by message[isNotNull]
string
message[isNot] Optional

Filter by message[isNot]
string
message[isNull] Optional

Filter by message[isNull]
string
message[is] Optional

Filter by message[is]
string
message[notContains] Optional

Filter by message[notContains]
string
message[notEndsWith] Optional

Filter by message[notEndsWith]
string
message[notIn] Optional

Filter by message[notIn]
string
message[notStartsWith] Optional

Filter by message[notStartsWith]
string
message[startsWith] Optional

Filter by message[startsWith]
string
nextPageLink Optional

A nextPageLink value, as fetched via a past call to a list API method. When a nextPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.
string
prevPageLink Optional

A prevPageLink value, as fetched via a past call to a list API method. When a prevPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.
string
segmentName[contains] Optional

Filter by segmentName[contains]
string
segmentName[endsWith] Optional

Filter by segmentName[endsWith]
string
segmentName[in] Optional

Filter by segmentName[in]
string
segmentName[isNotNull] Optional

Filter by segmentName[isNotNull]
string
segmentName[isNot] Optional

Filter by segmentName[isNot]
string
segmentName[isNull] Optional

Filter by segmentName[isNull]
string
segmentName[is] Optional

Filter by segmentName[is]
string
segmentName[notContains] Optional

Filter by segmentName[notContains]
string
segmentName[notEndsWith] Optional

Filter by segmentName[notEndsWith]
string
segmentName[notIn] Optional

Filter by segmentName[notIn]
string
segmentName[notStartsWith] Optional

Filter by segmentName[notStartsWith]
string
segmentName[startsWith] Optional

Filter by segmentName[startsWith]
string
severity[in] Optional

Filter by severity[in]
string
severity[isNot] Optional

Filter by severity[isNot]
string
severity[is] Optional

Filter by severity[is]
string
severity[notIn] Optional

Filter by severity[notIn]
integer
start Optional

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.

Response

Response

Response Body

Response Body

200 OK returns EnterpriseEventsSchema of type application/json

Request successfully processed

{
	"_href": "string",
	"data": [
		{
			"_href": "string",
			"category": "SYSTEM",
			"detail": "string",
			"edge": {
				"_href": "string",
				"activationKey": "string",
				"activationKeyExpires": "string",
				"activationState": "UNASSIGNED",
				"activationTime": "string",
				"alertsEnabled": false,
				"bastionState": "UNCONFIGURED",
				"buildNumber": "string",
				"created": "string",
				"customInfo": "string",
				"description": "string",
				"deviceFamily": "string",
				"deviceId": "string",
				"dnsName": "string",
				"edgeState": "NEVER_ACTIVATED",
				"edgeStateTime": "string",
				"endpointPkiMode": "CERTIFICATE_DISABLED",
				"enterprise": {
					"_href": "string",
					"accountNumber": "string",
					"alertsEnabled": false,
					"bastionState": "UNCONFIGURED",
					"city": "string",
					"contactEmail": "string",
					"contactMobile": "string",
					"contactName": "string",
					"contactPhone": "string",
					"country": "string",
					"created": "string",
					"description": "string",
					"domain": "string",
					"endpointPkiMode": "CERTIFICATE_DISABLED",
					"gatewayPool": {
						"_href": "string"
					},
					"lat": 0,
					"locale": "string",
					"logicalId": "string",
					"lon": 0,
					"modified": "string",
					"name": "string",
					"operatorAlertsEnabled": false,
					"postalCode": "string",
					"prefix": "string",
					"state": "string",
					"streetAddress": "string",
					"streetAddress2": "string",
					"timezone": "string"
				},
				"factoryBuildNumber": "string",
				"factorySoftwareVersion": "string",
				"haLastContact": "string",
				"haPreviousState": "UNCONFIGURED",
				"haSerialNumber": "string",
				"haState": "UNCONFIGURED",
				"isLive": false,
				"lastContact": "string",
				"links": [
					{
						"_href": "string"
					}
				],
				"logicalId": "string",
				"lteRegion": "string",
				"modelNumber": "string",
				"modemBuildNumber": "string",
				"modemFirmwareVersion": "string",
				"modified": "string",
				"name": "string",
				"operatorAlertsEnabled": false,
				"platformBuildNumber": "string",
				"platformFirmwareVersion": "string",
				"selfMacAddress": "string",
				"serialNumber": "string",
				"serviceState": "IN_SERVICE",
				"serviceUpSince": "string",
				"site": {
					"_href": "string",
					"city": "string",
					"contactEmail": "string",
					"contactMobile": "string",
					"contactName": "string",
					"contactPhone": "string",
					"country": "string",
					"created": "string",
					"lat": 0,
					"locale": "string",
					"lon": 0,
					"modified": "string",
					"name": "string",
					"postalCode": "string",
					"shippingAddress": "string",
					"shippingAddress2": "string",
					"shippingCity": "string",
					"shippingContactName": "string",
					"shippingCountry": "string",
					"shippingPostalCode": "string",
					"shippingSameAsLocation": false,
					"shippingState": "string",
					"state": "string",
					"streetAddress": "string",
					"streetAddress2": "string",
					"timezone": "string"
				},
				"softwareUpdated": "string",
				"softwareVersion": "string",
				"systemUpSince": "string"
			},
			"event": "string",
			"eventTime": "string",
			"link": {
				"_href": "string",
				"alertsEnabled": false,
				"backupState": "UNCONFIGURED",
				"created": "string",
				"displayName": "string",
				"edge": {
					"_href": "string",
					"activationKey": "string",
					"activationKeyExpires": "string",
					"activationState": "UNASSIGNED",
					"activationTime": "string",
					"alertsEnabled": false,
					"bastionState": "UNCONFIGURED",
					"buildNumber": "string",
					"created": "string",
					"customInfo": "string",
					"description": "string",
					"deviceFamily": "string",
					"deviceId": "string",
					"dnsName": "string",
					"edgeState": "NEVER_ACTIVATED",
					"edgeStateTime": "string",
					"endpointPkiMode": "CERTIFICATE_DISABLED",
					"enterprise": {
						"_href": "string",
						"accountNumber": "string",
						"alertsEnabled": false,
						"bastionState": "UNCONFIGURED",
						"city": "string",
						"contactEmail": "string",
						"contactMobile": "string",
						"contactName": "string",
						"contactPhone": "string",
						"country": "string",
						"created": "string",
						"description": "string",
						"domain": "string",
						"endpointPkiMode": "CERTIFICATE_DISABLED",
						"gatewayPool": {
							"_href": "string"
						},
						"lat": 0,
						"locale": "string",
						"logicalId": "string",
						"lon": 0,
						"modified": "string",
						"name": "string",
						"operatorAlertsEnabled": false,
						"postalCode": "string",
						"prefix": "string",
						"state": "string",
						"streetAddress": "string",
						"streetAddress2": "string",
						"timezone": "string"
					},
					"factoryBuildNumber": "string",
					"factorySoftwareVersion": "string",
					"haLastContact": "string",
					"haPreviousState": "UNCONFIGURED",
					"haSerialNumber": "string",
					"haState": "UNCONFIGURED",
					"isLive": false,
					"lastContact": "string",
					"links": [
						{
							"_href": "string"
						}
					],
					"logicalId": "string",
					"lteRegion": "string",
					"modelNumber": "string",
					"modemBuildNumber": "string",
					"modemFirmwareVersion": "string",
					"modified": "string",
					"name": "string",
					"operatorAlertsEnabled": false,
					"platformBuildNumber": "string",
					"platformFirmwareVersion": "string",
					"selfMacAddress": "string",
					"serialNumber": "string",
					"serviceState": "IN_SERVICE",
					"serviceUpSince": "string",
					"site": {
						"_href": "string",
						"city": "string",
						"contactEmail": "string",
						"contactMobile": "string",
						"contactName": "string",
						"contactPhone": "string",
						"country": "string",
						"created": "string",
						"lat": 0,
						"locale": "string",
						"lon": 0,
						"modified": "string",
						"name": "string",
						"postalCode": "string",
						"shippingAddress": "string",
						"shippingAddress2": "string",
						"shippingCity": "string",
						"shippingContactName": "string",
						"shippingCountry": "string",
						"shippingPostalCode": "string",
						"shippingSameAsLocation": false,
						"shippingState": "string",
						"state": "string",
						"streetAddress": "string",
						"streetAddress2": "string",
						"timezone": "string"
					},
					"softwareUpdated": "string",
					"softwareVersion": "string",
					"systemUpSince": "string"
				},
				"interface": "string",
				"internalId": "string",
				"ipAddress": "string",
				"ipV6Address": "string",
				"isp": "string",
				"lastActive": "string",
				"lastEvent": "string",
				"lastEventState": "UNKNOWN",
				"lat": 0,
				"linkMode": "ACTIVE",
				"logicalId": "string",
				"lon": 0,
				"macAddress": "string",
				"modified": "string",
				"netmask": "string",
				"networkSide": "UNKOWN",
				"networkType": "UNKNOWN",
				"operatorAlertsEnabled": false,
				"org": "string",
				"serviceState": "IN_SERVICE",
				"state": "UNKNOWN",
				"userOverride": false
			},
			"message": "string",
			"segment": {
				"_href": "string"
			},
			"service": {
				"_href": "string"
			},
			"severity": "EMERGENCY",
			"user": {
				"_href": "string"
			}
		}
	],
	"metaData": {
		"limit": 0,
		"more": false,
		"nextPageLink": "string",
		"prevPageLink": "string"
	}
}
string
_href Optional
array of InlineEnterpriseEventsSchemaDataArray
data Optional
InlineEnterpriseEventsSchemaMetaData
metaData Optional
Errors

Errors

ValidationError
400

ValidationError
UnAuthorized
401

Unauthorized
ResourceNotFoundError
404

Resource not found
RateLimitExceededError
429

Rate Limit Exceeded
InternalServerError
500

Internal server error
Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/events

Generated on: 12 May 22 14:40 UTC
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
On This Page
Monitor Operations
get
Get Enterprise Events
Feedback

Was this page helpful?

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