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

Get Enterprise Edges

Description

List Customer Edges

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


Query Parameters

Query Parameters

string
activationState[in] Optional

Filter by activationState[in]


string
activationState[isNot] Optional

Filter by activationState[isNot]


string
activationState[is] Optional

Filter by activationState[is]


string
activationState[notIn] Optional

Filter by activationState[notIn]


string
buildNumber[contains] Optional

Filter by buildNumber[contains]


string
buildNumber[endsWith] Optional

Filter by buildNumber[endsWith]


string
buildNumber[in] Optional

Filter by buildNumber[in]


string
buildNumber[isNotNull] Optional

Filter by buildNumber[isNotNull]


string
buildNumber[isNot] Optional

Filter by buildNumber[isNot]


string
buildNumber[isNull] Optional

Filter by buildNumber[isNull]


string
buildNumber[is] Optional

Filter by buildNumber[is]


string
buildNumber[notContains] Optional

Filter by buildNumber[notContains]


string
buildNumber[notEndsWith] Optional

Filter by buildNumber[notEndsWith]


string
buildNumber[notIn] Optional

Filter by buildNumber[notIn]


string
buildNumber[notStartsWith] Optional

Filter by buildNumber[notStartsWith]


string
buildNumber[startsWith] Optional

Filter by buildNumber[startsWith]


integer
created[greaterOrEquals] Optional

Filter by created[greaterOrEquals]


integer
created[in] Optional

Filter by created[in]


integer
created[isNotNull] Optional

Filter by created[isNotNull]


integer
created[isNot] Optional

Filter by created[isNot]


integer
created[isNull] Optional

Filter by created[isNull]


integer
created[is] Optional

Filter by created[is]


integer
created[lesserOrEquals] Optional

Filter by created[lesserOrEquals]


integer
created[notIn] Optional

Filter by created[notIn]


string
customInfo[contains] Optional

Filter by customInfo[contains]


string
customInfo[endsWith] Optional

Filter by customInfo[endsWith]


string
customInfo[in] Optional

Filter by customInfo[in]


string
customInfo[isNotNull] Optional

Filter by customInfo[isNotNull]


string
customInfo[isNot] Optional

Filter by customInfo[isNot]


string
customInfo[isNull] Optional

Filter by customInfo[isNull]


string
customInfo[is] Optional

Filter by customInfo[is]


string
customInfo[notContains] Optional

Filter by customInfo[notContains]


string
customInfo[notEndsWith] Optional

Filter by customInfo[notEndsWith]


string
customInfo[notIn] Optional

Filter by customInfo[notIn]


string
customInfo[notStartsWith] Optional

Filter by customInfo[notStartsWith]


string
customInfo[startsWith] Optional

Filter by customInfo[startsWith]


string
edgeState[in] Optional

Filter by edgeState[in]


string
edgeState[isNot] Optional

Filter by edgeState[isNot]


string
edgeState[is] Optional

Filter by edgeState[is]


string
edgeState[notIn] Optional

Filter by edgeState[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.


string
modelNumber[in] Optional

Filter by modelNumber[in]


string
modelNumber[isNot] Optional

Filter by modelNumber[isNot]


string
modelNumber[is] Optional

Filter by modelNumber[is]


string
modelNumber[notIn] Optional

Filter by modelNumber[notIn]


string
name[contains] Optional

Filter by name[contains]


string
name[endsWith] Optional

Filter by name[endsWith]


string
name[in] Optional

Filter by name[in]


string
name[isNotNull] Optional

Filter by name[isNotNull]


string
name[isNot] Optional

Filter by name[isNot]


string
name[isNull] Optional

Filter by name[isNull]


string
name[is] Optional

Filter by name[is]


string
name[notContains] Optional

Filter by name[notContains]


string
name[notEndsWith] Optional

Filter by name[notEndsWith]


string
name[notIn] Optional

Filter by name[notIn]


string
name[notStartsWith] Optional

Filter by name[notStartsWith]


string
name[startsWith] Optional

Filter by name[startsWith]


string
serialNumber[contains] Optional

Filter by serialNumber[contains]


string
serialNumber[endsWith] Optional

Filter by serialNumber[endsWith]


string
serialNumber[in] Optional

Filter by serialNumber[in]


string
serialNumber[isNotNull] Optional

Filter by serialNumber[isNotNull]


string
serialNumber[isNot] Optional

Filter by serialNumber[isNot]


string
serialNumber[isNull] Optional

Filter by serialNumber[isNull]


string
serialNumber[is] Optional

Filter by serialNumber[is]


string
serialNumber[notContains] Optional

Filter by serialNumber[notContains]


string
serialNumber[notEndsWith] Optional

Filter by serialNumber[notEndsWith]


string
serialNumber[notIn] Optional

Filter by serialNumber[notIn]


string
serialNumber[notStartsWith] Optional

Filter by serialNumber[notStartsWith]


string
serialNumber[startsWith] Optional

Filter by serialNumber[startsWith]


integer
softwareUpdated[greaterOrEquals] Optional

Filter by softwareUpdated[greaterOrEquals]


integer
softwareUpdated[in] Optional

Filter by softwareUpdated[in]


integer
softwareUpdated[isNotNull] Optional

Filter by softwareUpdated[isNotNull]


integer
softwareUpdated[isNot] Optional

Filter by softwareUpdated[isNot]


integer
softwareUpdated[isNull] Optional

Filter by softwareUpdated[isNull]


integer
softwareUpdated[is] Optional

Filter by softwareUpdated[is]


integer
softwareUpdated[lesserOrEquals] Optional

Filter by softwareUpdated[lesserOrEquals]


integer
softwareUpdated[notIn] Optional

Filter by softwareUpdated[notIn]


string
softwareVersion[contains] Optional

Filter by softwareVersion[contains]


string
softwareVersion[endsWith] Optional

Filter by softwareVersion[endsWith]


string
softwareVersion[in] Optional

Filter by softwareVersion[in]


string
softwareVersion[isNotNull] Optional

Filter by softwareVersion[isNotNull]


string
softwareVersion[isNot] Optional

Filter by softwareVersion[isNot]


string
softwareVersion[isNull] Optional

Filter by softwareVersion[isNull]


string
softwareVersion[is] Optional

Filter by softwareVersion[is]


string
softwareVersion[notContains] Optional

Filter by softwareVersion[notContains]


string
softwareVersion[notEndsWith] Optional

Filter by softwareVersion[notEndsWith]


string
softwareVersion[notIn] Optional

Filter by softwareVersion[notIn]


string
softwareVersion[notStartsWith] Optional

Filter by softwareVersion[notStartsWith]


string
softwareVersion[startsWith] Optional

Filter by softwareVersion[startsWith]


Response

Response

Response Body

Response Body

200 OK returns EdgeResourceCollection of type application/json

Request successfully processed

{
	"_href": "string",
	"data": [
		{
			"_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"
		}
	],
	"metaData": {
		"limit": 0,
		"more": false,
		"nextPageLink": "string",
		"prevPageLink": "string"
	}
}
string
_href Optional

data Optional

Errors

Errors

400

ValidationError


401

Unauthorized


404

Resource not found


429

Rate Limit Exceeded


500

Internal server error

Code Samples

Code Samples

cURL Command

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


Feedback

Was this page helpful?