[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Get All Uag Deployments

Description

Get all UAG deployments

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/admin/v2/uag-deployments
Copy

Query Parameters

Query Parameters

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PageUAGDeploymentTOV2 of type */*

Successfully retrieved all deployments

{
	"content": [
		{
			"createdAt": "string",
			"description": "string",
			"edgeDeploymentId": "1234",
			"errorDetails": [
				{
					"cause": "ErrorDetail Object",
					"code": "string",
					"detail": "string",
					"domain": "string",
					"message": "string",
					"parameters": {
						"key": "string"
					},
					"severity": "string",
					"timestampInUtc": "string"
				}
			],
			"fqdn": "www.example.com",
			"gateways": [
				{
					"desktopPrivateIp": "2.2.2.2",
					"dmzPrivateIp": "3.3.3.3",
					"errorDetails": [
						{
							"cause": "ErrorDetail Object",
							"code": "string",
							"detail": "string",
							"domain": "string",
							"message": "string",
							"parameters": {
								"key": "string"
							},
							"severity": "string",
							"timestampInUtc": "string"
						}
					],
					"id": "string",
					"managementPrivateIp": "1.1.1.1",
					"markedForDeletion": false,
					"status": "READY",
					"version": "22.03",
					"vmName": "VM-001"
				}
			],
			"hdc": {
				"edgeHubUrl": "string",
				"id": "string",
				"modelVersion": 0,
				"name": "string",
				"url": "string",
				"vmHub": {
					"name": "string",
					"url": "string"
				},
				"vmHubName": "string",
				"vmHubURL": "string"
			},
			"id": "string",
			"infrastructure": {
				"key": {
					"data": {},
					"id": "string",
					"infrastructureLinks": {},
					"kind": "string"
				}
			},
			"loadBalancer": {
				"empty": false,
				"fqdn": "string",
				"ipAddress": "string",
				"publicIpEnabled": false
			},
			"location": "US",
			"name": "My Instance Name",
			"numberOfGateways": 2,
			"orgId": "0123456789",
			"passwordCredentialId": "string",
			"privateLoadBalancer": {
				"empty": false,
				"fqdn": "string",
				"ipAddress": "string",
				"publicIpEnabled": false
			},
			"providerInstanceId": "0123456789",
			"providerLabel": "AZURE",
			"proxyConfiguration": {
				"certificateData": "string",
				"certificateName": "string",
				"deleting": false,
				"proxyHost": "string",
				"proxyIncludedHosts": [
					"string"
				],
				"proxyName": "string",
				"proxyPort": 0,
				"proxyType": "HTTP"
			},
			"reportedProperties": {
				"location": "string",
				"orgId": "string",
				"reportedGatewayDetails": [
					{
						"certUpdateErrorDetails": [
							{
								"cause": "ErrorDetail Object",
								"code": "string",
								"detail": "string",
								"domain": "string",
								"message": "string",
								"parameters": {
									"key": "string"
								},
								"severity": "string",
								"timestampInUtc": "string"
							}
						],
						"certUpdateStatus": "DELETED",
						"fqdnUpdateErrorDetails": [
							{
								"cause": "ErrorDetail Object",
								"code": "string",
								"detail": "string",
								"domain": "string",
								"message": "string",
								"parameters": {
									"key": "string"
								},
								"severity": "string",
								"timestampInUtc": "string"
							}
						],
						"fqdnUpdateStatus": "DELETED",
						"gatewayHealthErrorDetails": [
							{
								"cause": "ErrorDetail Object",
								"code": "string",
								"detail": "string",
								"domain": "string",
								"message": "string",
								"parameters": {
									"key": "string"
								},
								"severity": "string",
								"timestampInUtc": "string"
							}
						],
						"gatewayHealthStatus": "ERROR",
						"gatewayId": "string",
						"proxyUpdateErrorDetails": [
							{
								"cause": "ErrorDetail Object",
								"code": "string",
								"detail": "string",
								"domain": "string",
								"message": "string",
								"parameters": {
									"key": "string"
								},
								"severity": "string",
								"timestampInUtc": "string"
							}
						],
						"proxyUpdateStatus": "DELETED",
						"serviceHealthStatus": {
							"key": "DOWN"
						}
					}
				],
				"reportedLoadBalancerDetails": [
					{
						"errorDetails": [
							{
								"cause": "ErrorDetail Object",
								"code": "string",
								"detail": "string",
								"domain": "string",
								"message": "string",
								"parameters": {
									"key": "string"
								},
								"severity": "string",
								"timestampInUtc": "string"
							}
						],
						"ip": "string",
						"status": "DOWN",
						"type": "PRIVATE_IP"
					}
				],
				"uagDeploymentId": "string",
				"updatedAt": "string",
				"version": 0
			},
			"resourceTags": {
				"key": "string"
			},
			"sslCertificateCredentialId": "string",
			"sslCertificateTO": {
				"credentialId": "string",
				"expiryDate": "string",
				"sslCertificateType": "PEM"
			},
			"status": "PENDING",
			"type": "EXTERNAL | INTERNAL | INTERNAL_AND_EXTERNAL",
			"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
}
content Optional

Searchable fields are “id”, “name”, “type”, “providerInstanceId”, “providerLabel”, “status”


boolean
empty Optional

boolean
first Optional

boolean
last Optional

integer as int32
number Optional

integer as int32
numberOfElements Optional

pageable Optional

integer as int32
size Optional

sort Optional

integer as int64
totalElements Optional

integer as int32
totalPages Optional
Errors

Errors

401

Unauthorized


403

Forbidden


404

Not Found

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/admin/v2/uag-deployments


Feedback

Was this page helpful?