[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Get All Edge Deployments
DescriptionGet all Edge deployments
Request
URLURL
https://cloud.vmwarehorizon.com/admin/v2/edge-deployments
Query Parameters
Query Parameters
boolean
include_reported_status
Optional
Status of edge reported attributes
string
org_id
Optional
Organization ID: non-super users can only access their own organization
string
page
Optional
Page number to retrieve.
string
search
Optional
Search Criteria. Please see model definition for list of searchable fields.
search example
"id $eq id-1"
string
size
Optional
Size of each page.
array of
string
sort
Optional
Ascending/Descending. Format is property,{asc|desc} and default is ascending.
Parameter Serialization Style:
form Explode:true
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PageEdgeDeploymentTOV2
of type */*
Successfully retrieved all edge deployments
{
"content": [
{
"adMonitoring": {
"enabled": false,
"interval": 0,
"statusMap": {
"key": {
"errorDetails": [
{
"cause": "ErrorDetail Object",
"code": "string",
"detail": "string",
"domain": "string",
"message": "string",
"parameters": {
"key": "string"
},
"severity": "string",
"timestampInUtc": "string"
}
],
"message": "string",
"status": 0
}
}
},
"adTwinSyncStatus": "SYNCED",
"agentMonitoringConfig": {
"dataToCollect": [
"string"
],
"interval": 0
},
"authEngine": {
"status": {
"endpoint": "string",
"errorDetails": [
{
"cause": "ErrorDetail Object",
"code": "string",
"detail": "string",
"domain": "string",
"message": "string",
"parameters": {
"key": "string"
},
"severity": "string",
"timestampInUtc": "string"
}
],
"message": "string",
"status": 0
},
"url": "string"
},
"createdAt": "string",
"deploymentModeDetails": {
"attributes": {
"key": "172.17.0.1/16 | identiy-id | 4 | 192.168.0.0/16 | 192.169.0.0/24"
},
"type": "CLUSTER"
},
"description": "My new edge deployment",
"edgeGatewayLocation": {
"deviceId": "string",
"iotDeviceName": "string"
},
"edgeVmDetails": {
"credentialId": "string",
"managementIp": "string"
},
"errorDetails": [
{
"cause": "ErrorDetail Object",
"code": "string",
"detail": "string",
"domain": "string",
"message": "string",
"parameters": {
"key": "string"
},
"severity": "string",
"timestampInUtc": "string"
}
],
"fqdn": "edge.example.com",
"hdc": {
"edgeHubUrl": "string",
"id": "string",
"modelVersion": 0,
"name": "string",
"url": "string",
"vmHub": {
"name": "string",
"url": "string"
},
"vmHubName": "string",
"vmHubURL": "string"
},
"id": "id",
"infrastructure": {
"key": {
"data": {},
"id": "string",
"infrastructureLinks": {},
"kind": "string"
}
},
"location": "US",
"name": "edge-deployment-1",
"orgId": "orgId",
"privateEndpointDetails": {
"dnsRecord": "string",
"ip": "string",
"name": "string",
"nicResourceId": "string",
"privateLinkServiceId": "string",
"provisioningState": "string"
},
"providerInstanceId": "providerInstanceId",
"providerLabel": "AZURE|VSPHERE",
"proxyConfiguration": {
"credentialId": "string",
"deleting": false,
"exclusionPolicy": [
"string"
],
"proxyHost": "string",
"proxyName": "string",
"proxyPort": "string",
"proxyType": "HTTP",
"sslEnabled": false
},
"registeredModules": {
"key": "string"
},
"reportedStatus": {
"deviceConnectionDetails": {
"deviceId": "string",
"deviceStatus": "CONNECTED",
"updatedAt": "string"
},
"edgeClusterReported": {
"key": {
"errorDetail": {
"cause": "ErrorDetail Object",
"code": "string",
"detail": "string",
"domain": "string",
"message": "string",
"parameters": {
"key": "string"
},
"severity": "string",
"timestampInUtc": "string"
},
"validationDetails": {},
"validationType": "string"
}
},
"edgeConfigDetails": {
"agentSimulatorIp": "string",
"mqttLoadBalancerIP": "string",
"updatedAt": "string"
},
"moduleConnectionDetails": [
{
"moduleName": "string",
"moduleStatus": "CONNECTED",
"twinId": "string",
"updatedAt": "string"
}
],
"updatedAt": "string"
},
"resourceTags": {
"key": "string"
},
"ssoConfigurations": [
{
"caMode": "sub",
"name": "my-sso",
"ssoConfigurationId": "sso-id-1",
"status": {
"adDomainsStatus": [
{
"adId": "string",
"message": "string",
"status": 0
}
],
"caBundlesStatus": [
{
"caCertVersion": 0,
"installed": false
}
],
"message": "string",
"status": 0
}
}
],
"status": "PENDING",
"twinSyncStatusMap": {
"key": "NONE"
},
"updatedAt": "string",
"version": 0
}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}
array of
EdgeDeploymentTOV2
content
Optional
Searchable fields are “id”, “name”, “providerLabel”, “providerInstanceId”, “status”
boolean
empty
Optional
boolean
first
Optional
boolean
last
Optional
integer as int32
number
Optional
integer as int32
numberOfElements
Optional
integer as int32
size
Optional
integer as int64
totalElements
Optional
integer as int32
totalPages
Optional
Errors
ErrorResponse
401
Unauthorized
ErrorResponse
403
Forbidden
ErrorResponse
404
Not Found
ErrorResponse
500
Unexpected internal server error
Code Samples
cURL Command
curl https://cloud.vmwarehorizon.com/admin/v2/edge-deployments
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
On This Page
Admin Operations
post
patch
delete
