[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform

Get Enterprise Alerts

Description

Fetch past triggered alerts for the specified enterprise

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/alerts
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


Query Parameters

Query Parameters

string
edgeName[contains] Optional

Filter by edgeName[contains]


string
edgeName[notContains] Optional

Filter by edgeName[notContains]


integer
end Optional

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


number
enterpriseAlertConfigurationId[isNotNull] Optional

Filter by enterpriseAlertConfigurationId[isNotNull]


number
enterpriseAlertConfigurationId[isNull] Optional

Filter by enterpriseAlertConfigurationId[isNull]


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
linkName[contains] Optional

Filter by linkName[contains]


string
linkName[notContains] Optional

Filter by linkName[notContains]


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.


integer
start Optional

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


string
state[in] Optional

Filter by state[in]

Possible values are: PENDINGACTIVECLOSED


string
state[isNot] Optional

Filter by state[isNot]

Possible values are: PENDINGACTIVECLOSED


string
state[is] Optional

Filter by state[is]

Possible values are: PENDINGACTIVECLOSED


string
state[notIn] Optional

Filter by state[notIn]

Possible values are: PENDINGACTIVECLOSED


string
type[in] Optional

Filter by type[in]

Possible values are: EDGE_DOWNEDGE_UPLINK_DOWNLINK_UPVPN_TUNNEL_DOWNEDGE_HA_FAILOVEREDGE_SERVICE_DOWNGATEWAY_SERVICE_DOWNVNF_VM_EVENTVNF_VM_DEPLOYEDVNF_VM_POWERED_ONVNF_VM_POWERED_OFFVNF_VM_DEPLOYED_AND_POWERED_OFFVNF_VM_DELETEDVNF_VM_ERRORVNF_INSERTION_EVENTVNF_INSERTION_ENABLEDVNF_INSERTION_DISABLEDTEST_ALERTEDGE_CSS_TUNNEL_DOWNEDGE_CSS_TUNNEL_UPNVS_FROM_EDGE_TUNNEL_DOWNNVS_FROM_EDGE_TUNNEL_UPVNF_IMAGE_DOWNLOAD_EVENTVNF_IMAGE_DOWNLOAD_IN_PROGRESSVNF_IMAGE_DOWNLOAD_COMPLETEDVNF_IMAGE_DOWNLOAD_FAILED


string
type[isNot] Optional

Filter by type[isNot]

Possible values are: EDGE_DOWNEDGE_UPLINK_DOWNLINK_UPVPN_TUNNEL_DOWNEDGE_HA_FAILOVEREDGE_SERVICE_DOWNGATEWAY_SERVICE_DOWNVNF_VM_EVENTVNF_VM_DEPLOYEDVNF_VM_POWERED_ONVNF_VM_POWERED_OFFVNF_VM_DEPLOYED_AND_POWERED_OFFVNF_VM_DELETEDVNF_VM_ERRORVNF_INSERTION_EVENTVNF_INSERTION_ENABLEDVNF_INSERTION_DISABLEDTEST_ALERTEDGE_CSS_TUNNEL_DOWNEDGE_CSS_TUNNEL_UPNVS_FROM_EDGE_TUNNEL_DOWNNVS_FROM_EDGE_TUNNEL_UPVNF_IMAGE_DOWNLOAD_EVENTVNF_IMAGE_DOWNLOAD_IN_PROGRESSVNF_IMAGE_DOWNLOAD_COMPLETEDVNF_IMAGE_DOWNLOAD_FAILED


string
type[is] Optional

Filter by type[is]

Possible values are: EDGE_DOWNEDGE_UPLINK_DOWNLINK_UPVPN_TUNNEL_DOWNEDGE_HA_FAILOVEREDGE_SERVICE_DOWNGATEWAY_SERVICE_DOWNVNF_VM_EVENTVNF_VM_DEPLOYEDVNF_VM_POWERED_ONVNF_VM_POWERED_OFFVNF_VM_DEPLOYED_AND_POWERED_OFFVNF_VM_DELETEDVNF_VM_ERRORVNF_INSERTION_EVENTVNF_INSERTION_ENABLEDVNF_INSERTION_DISABLEDTEST_ALERTEDGE_CSS_TUNNEL_DOWNEDGE_CSS_TUNNEL_UPNVS_FROM_EDGE_TUNNEL_DOWNNVS_FROM_EDGE_TUNNEL_UPVNF_IMAGE_DOWNLOAD_EVENTVNF_IMAGE_DOWNLOAD_IN_PROGRESSVNF_IMAGE_DOWNLOAD_COMPLETEDVNF_IMAGE_DOWNLOAD_FAILED


string
type[notIn] Optional

Filter by type[notIn]

Possible values are: EDGE_DOWNEDGE_UPLINK_DOWNLINK_UPVPN_TUNNEL_DOWNEDGE_HA_FAILOVEREDGE_SERVICE_DOWNGATEWAY_SERVICE_DOWNVNF_VM_EVENTVNF_VM_DEPLOYEDVNF_VM_POWERED_ONVNF_VM_POWERED_OFFVNF_VM_DEPLOYED_AND_POWERED_OFFVNF_VM_DELETEDVNF_VM_ERRORVNF_INSERTION_EVENTVNF_INSERTION_ENABLEDVNF_INSERTION_DISABLEDTEST_ALERTEDGE_CSS_TUNNEL_DOWNEDGE_CSS_TUNNEL_UPNVS_FROM_EDGE_TUNNEL_DOWNNVS_FROM_EDGE_TUNNEL_UPVNF_IMAGE_DOWNLOAD_EVENTVNF_IMAGE_DOWNLOAD_IN_PROGRESSVNF_IMAGE_DOWNLOAD_COMPLETEDVNF_IMAGE_DOWNLOAD_FAILED


Response

Response

Response Body

Response Body

200 OK

Returns EnterpriseAlertsSchema of type application/json

Request successfully processed

{
	"_href": "string",
	"data": [
		{
			"_href": "string",
			"comment": "string",
			"created": "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"
			},
			"firstNotificationSeconds": 0,
			"lastContact": "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
			},
			"locale": "string",
			"maxNotifications": 0,
			"modified": "string",
			"name": "EDGE_DOWN",
			"nextNotificationTime": "string",
			"notificationIntervalSeconds": 0,
			"notifications": [
				{
					"created": "string",
					"emailEnabled": 0,
					"emailList": "string",
					"emailText": "string",
					"enterpriseUserList": [
						{
							"email": "string",
							"emailEnabled": 0,
							"enabled": 0,
							"mobileEnabled": 0,
							"mobilePhone": "string",
							"smsEnabled": 0,
							"username": "string"
						}
					],
					"mobileEnabled": 0,
					"mobileList": "string",
					"mobileText": "string",
					"modified": "string",
					"smsEnabled": 0,
					"smsList": "string",
					"smsText": "string",
					"snmpEnabled": 0,
					"snmpList": "string"
				}
			],
			"remainingNotifications": 0,
			"resetIntervalSeconds": 0,
			"state": "PENDING",
			"stateSetTime": "string",
			"timezone": "string",
			"triggerTime": "string",
			"type": "EDGE_DOWN"
		}
	],
	"metaData": {
		"limit": 0,
		"more": false,
		"nextPageLink": "string",
		"prevPageLink": "string"
	}
}
string
_href Optional

data Optional

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


[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
Feedback

Was this page helpful?