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

Get Enterprise Aggregate Health Stats

Description

Fetch aggregate Edge health metrics for all Edges belonging to the target customer

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


Query Parameters

Query Parameters

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.


string
metrics Optional

Response

Response

Response Body

Response Body

200 OK

Returns EnterpriseHealthStatsSchema of type application/json

Request successfully processed

{
	"_href": "string",
	"data": [
		{
			"cpuCoreTemp": 0,
			"cpuPct": 0,
			"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"
			},
			"flowCount": 0,
			"handoffQueueDrops": 0,
			"memoryPct": 0,
			"tunnelCount": 0,
			"tunnelCountV6": 0
		}
	],
	"metaData": {
		"limit": 0,
		"more": false,
		"nextPageLink": "string",
		"prevPageLink": "string"
	}
}
string
_href Optional

data Changed Optional

metaData Changed 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}/healthStats


[{"label":"Latest (2022-09-01)","version":"latest"},{"version":"v1.0"}]
vmware-sase-platform
What's changed in 2022-09-01?
CHANGED (1)
Changed Data Structures

Feedback

Was this page helpful?