[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Get All

Description

Get all templates, with filtering and paging.

Request

URL

get

https://cloud.vmwarehorizon.com/admin/v2/templates

Copy

Query Parameters

boolean

brokerable_only Optional

Limit results to templates that can be used for end-user connections

boolean

expanded Optional

If true, results will contain (limited) expanded data in addition to foreign IDs

string

org_id Optional

Organization ID: non-super users can only access their own organization

string

page Optional

Page number to retrieve.

string

reported_search Optional

Search expression for selection of template reported properties

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

string

template_search Optional

Search expression for selection of templates

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response Body

200 OK

Returns PageTemplateTOV2 of type */*

Successfully retrieved templates

{
	"content": [
		{
			"activeDirectoryId": "string",
			"agentCustomization": {
				"demSettingId": "string",
				"disconnectSessionTimeoutMins": 0,
				"dtemplateName": "string",
				"emptySessionLogoffType": "DISCONNECT",
				"emptySessionTimeoutMins": 0,
				"esUrl": "string",
				"proxyInfo": {
					"bypass": "10.12.100.10;10.120.100.10;100.12.*.100",
					"server": "http://<<ipaddress or cname>>:<<port>>"
				},
				"runOnceCommand": "string",
				"sessionLoadBalancingSettings": {
					"LBCHANGETHRESHOLD": 1,
					"LBCPUTHRESHOLD": 50,
					"LBDISKQUEUELENTHRESHOLD": 50,
					"LBDISKREADLATENCYTHRESHOLD": 50,
					"LBDISKWRITELATENCYTHRESHOLD": 50,
					"LBINCLUDESESSIONCOUNT": true,
					"LBMEMTHRESHOLD": 50,
					"LBUSECUSTOMSCRIPT": false,
					"loadIndexThresholdPercent": 0,
					"modelVersion": 0
				},
				"sessionsPerVm": 1,
				"skipDomainJoin": false
			},
			"applicationProperties": {
				"key": "string"
			},
			"clientAccessLicenseApplicable": false,
			"computerAccountOU": "string",
			"createdAt": "string",
			"deleting": false,
			"description": "My floating desktop template",
			"desktopAdminCredentialId": "string",
			"desktopAdminUsername": "string",
			"diskEncryption": {
				"enabled": false,
				"modelVersion": 0
			},
			"diskSizeInGB": 0,
			"edgeDeployment": {
				"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": "4 | 192.168.0.0/16 | 192.169.0.0/24 | 172.17.0.1/16 | identiy-id"
					},
					"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
			},
			"edgeDeploymentId": "string",
			"hdc": {
				"edgeHubUrl": "string",
				"id": "string",
				"modelVersion": 0,
				"name": "string",
				"url": "string",
				"vmHub": {
					"name": "string",
					"url": "string"
				},
				"vmHubName": "string",
				"vmHubURL": "string"
			},
			"id": "string",
			"imageId": "string",
			"imageReference": {
				"markerId": "string",
				"modelVersion": 0,
				"streamId": "string",
				"versionId": "string"
			},
			"infrastructure": {
				"key": {
					"data": {},
					"id": "string",
					"infrastructureLinks": {},
					"kind": "string"
				}
			},
			"licenseProvided": false,
			"location": "US",
			"maxQuiescingServers": 10,
			"name": "My floating desktop template",
			"networks": [
				{
					"data": {},
					"id": "string",
					"infrastructureLinks": {},
					"kind": "string"
				}
			],
			"orgId": "string",
			"parentId": "string",
			"powerPolicy": {
				"enabled": false,
				"min": 2,
				"minUnit": "PERCENTAGE",
				"modelVersion": 0,
				"occupancyPresetMode": "BALANCED",
				"powerOffProtectTimeMins": 30,
				"powerSchedules": [
					{
						"allDay": false,
						"endTime": "17:00",
						"min": 5,
						"modelVersion": 0,
						"name": "VmwareWeekdaySchedule",
						"occursOn": 31,
						"startTime": "08:00",
						"timeZone": "Asia/Tokyo"
					}
				]
			},
			"protocols": [
				"BLAST"
			],
			"providerInstance": {
				"createdAt": "string",
				"credentialId": "0123456789",
				"denyOperations": [
					"EDGE_DEPLOYMENT"
				],
				"description": "string",
				"edgeDeploymentId": "0123456789",
				"hdc": {
					"edgeHubUrl": "string",
					"id": "string",
					"modelVersion": 0,
					"name": "string",
					"url": "string",
					"vmHub": {
						"name": "string",
						"url": "string"
					},
					"vmHubName": "string",
					"vmHubURL": "string"
				},
				"healthStatusDetails": {
					"errorDetails": [
						{
							"cause": "ErrorDetail Object",
							"code": "string",
							"detail": "string",
							"domain": "string",
							"message": "string",
							"parameters": {
								"key": "string"
							},
							"severity": "string",
							"timestampInUtc": "string"
						}
					],
					"providerInstanceHealthStatus": "OK|ERROR|WARNING",
					"updatedAt": "string",
					"version": 0
				},
				"id": "0123456789",
				"infraTwinId": "0123456789",
				"infraTwinSyncStatus": "READY",
				"infrastructureLinks": {
					"key": "string"
				},
				"location": "US",
				"name": "My Instance Name",
				"orgId": "0123456789",
				"primaryProvider": false,
				"providerDetails": {
					"data": {
						"key": "string"
					},
					"method": "ByAppRegistration"
				},
				"providerLabel": "AZURE",
				"resourceTags": {
					"key": "string"
				},
				"updatedAt": "string",
				"version": 0
			},
			"providerInstanceId": "string",
			"providerLabel": "AZURE|VSPHERE",
			"reportedStatus": {
				"agentUpdateScanTime": "string",
				"connectivityStatus": "OFFLINE",
				"consumedVMs": 0,
				"deletingVMs": 0,
				"errorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						},
						"severity": "string",
						"timestampInUtc": "string"
					}
				],
				"errorVMs": 0,
				"freeSessions": 0,
				"location": "string",
				"maintenanceVMs": 0,
				"messages": [
					{
						"code": "string",
						"message": "string",
						"time": "string"
					}
				],
				"orgId": "string",
				"outdatedAgentVMs": 0,
				"provisionedSessions": 0,
				"provisionedVMs": 0,
				"provisioningVMs": 0,
				"status": "string",
				"templateId": "string",
				"updatedAt": "string",
				"version": 0
			},
			"resourceTags": {
				"key": "string"
			},
			"sessionsPerVm": 0,
			"sparePolicy": {
				"increment": 200,
				"limit": 10,
				"max": 4,
				"min": 2,
				"modelVersion": 0
			},
			"syncStatus": "SYNC_COMPLETE",
			"templateConnectivityStatus": "OFFLINE",
			"templateType": "APP_CAPTURE_STUDIO",
			"transientLoadThresholdSecs": 10,
			"uagDeployment": {
				"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
			},
			"uagDeploymentId": "string",
			"updatedAt": "string",
			"vmLicenseType": "NONE",
			"vmNamePattern": "string"
		}
	],
	"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 TemplateTOV2

content Optional

Searchable fields are “id”,“activeDirectoryId”,“diskEncryption.enabled”,“edgeDeploymentId”,“imageReference.streamId”,“imageReference.versionId”,“imageReference.markerId”,“name”,“parentId”,“protocols”,“providerInstanceId”,“templateType”,“uagDeploymentId”

boolean

empty Optional

boolean

first Optional

boolean

last Optional

integer as int32

number Optional

integer as int32

numberOfElements Optional

Pageable

pageable Optional

integer as int32

size Optional

Sort

sort Optional

integer as int64

totalElements Optional

integer as int32

totalPages Optional

Errors

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

404

Not Found

ErrorResponse

500

Unexpected internal server error

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/admin/v2/templates

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Admin Operations

post

Create

post

Create Expansion

get

Get All

get

Get By ID

get

Get Error Report

patch

Patch By ID

patch

Patch Expansion By ID

patch

Patch Pool Settings By Template ID

post

Perform Action

delete

delete Templates

Get All

Request

URL

Query Parameters

Authentication

Bearer

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Admin Operations

Was this page helpful?