[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Get Pools
DescriptionGet all pools, with an optional org ID filter. Non-super users can only query for their own org IDs. This will return all records for which the caller has ‘read’ permission
Request
URLURL
https://cloud.vmwarehorizon.com/portal/v2/pools
Query Parameters
Query Parameters
boolean
include_internal_pools
Optional
include_internal_pools
string
org_id
Optional
org_id
string
page
Optional
Page number to retrieve.
string
search
Optional
Search Criteria. Please see model definition for list of searchable fields.
search example
"name $eq name-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
boolean
sort_by_consumed_sessions
Optional
sort_by_consumed_sessions
boolean
sort_by_used_sessions
Optional
sort_by_used_sessions
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PagePool
of type */*
{
"content": [
{
"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
},
"agentCustomizationStatus": "ACTIVE",
"applications": [
{
"displayName": "Google Chrome",
"icons": {
"key": {
"height": 0,
"iconHash": "string",
"icondata": "string",
"path": "string",
"width": 0
}
},
"id": "string",
"name": "Chrome",
"orgId": "0123456789",
"os": "Windows",
"path": "c:\\app\\chrome.exe",
"publisher": "VMware Inc",
"registeredExtensions": {
"extensions": [
{
"friendlyName": "string",
"value": "string"
}
],
"otherFileType": [
{
"friendlyName": "string",
"type": "string",
"value": "string"
}
]
},
"streamId": "string",
"templateIds": [
"string"
],
"version": "1.0.0",
"versionId": "string"
}
],
"connectionAffinity": "NEAREST_SITE",
"createdAt": "string",
"description": "Pool description",
"disabled": false,
"displayName": "NewPool",
"enableSSO": false,
"homesiteMappings": {
"key": "site-id-2 | site-id-1"
},
"id": "ent-id-12345",
"location": "US",
"name": "pg-123",
"orgId": "0123456789",
"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"
}
]
},
"preferredClientType": "HORIZON_CLIENT",
"protocols": [
{
"defaultProtocol": false,
"name": "BLAST"
}
],
"reportedCapacity": {
"consumedSessions": 0,
"consumedVMs": 0,
"freeSessions": 0,
"limit": 0,
"maxVMs": 0,
"provisionedSessions": 0,
"sessionLimit": 0,
"usedSessions": 0
},
"requireHomesite": true,
"scope": "ALL_SITES",
"templateType": "MULTI_SESSION",
"templates": [
{
"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
},
"avAgentInstalled": false,
"clientAccessLicenseApplicable": false,
"dataCenterId": "datacenter-1",
"delete": false,
"disabled": false,
"disassociateAction": "CLEANUP",
"edgeDeploymentId": "string",
"id": "template-1",
"imageReference": {
"markerId": "string",
"modelVersion": 0,
"streamId": "string",
"versionId": "string"
},
"location": "string",
"name": "string",
"orgId": "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"
}
]
},
"providerInstance": {
"id": "0123456789"
},
"templateType": "APP_CAPTURE_STUDIO",
"transientLoadThresholdSecs": 10,
"viewTemplate": false
}
],
"transientLoadThresholdSecs": 10,
"transientLoadThresholdSecsStatus": "ACTIVE",
"type": "DESKTOP",
"updatedAt": "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
}
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
Code Samples
cURL Command
curl https://cloud.vmwarehorizon.com/portal/v2/pools
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
On This Page
Portal Operations
post
delete
delete
get
get
patch
put
