[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
Get Enterprise Client Devices
DescriptionFetch all client devices
Request
URLURL
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/clientDevices
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.
Response
Response
Response BodyResponse Body
200 OK
Returns
array
of
ClientDeviceResource
of type application/json
Request successfully processed
{
"_href": "string",
"created": "string",
"deviceModel": "string",
"deviceType": "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",
"haMode": "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",
"standbyBuildNumber": "string",
"standbyDeviceId": "string",
"standbyFactoryBuildNumber": "string",
"standbyFactorySoftwareVersion": "string",
"standbyModelNumber": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbySystemUpSince": "string",
"systemUpSince": "string"
},
"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"
},
"hostName": "string",
"ipAddress": "string",
"lastContact": "string",
"logicalId": "string",
"macAddress": "string",
"modified": "string",
"os": 0,
"osName": "string",
"osVersion": "string",
"segmentId": 0
}
string
_href
Optional
string as date-time
created
Optional
string
deviceModel
Optional
string
deviceType
Optional
string
hostName
Optional
string
ipAddress
Optional
string as date-time
lastContact
Optional
string
logicalId
Optional
string
macAddress
Optional
string as date-time
modified
Optional
integer
os
Optional
string
osName
Optional
string
osVersion
Optional
integer
segmentId
Optional
Errors
UnAuthorized
401
Unauthorized
ResourceNotFoundError
404
Resource not found
RateLimitExceededError
429
Rate Limit Exceeded
InternalServerError
500
Internal server error
Code Samples
cURL Command
curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/clientDevices
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform