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

horizon-cloud-nextgen

List VMS With User

Description

excludeAssignedVms - If true - return only unassigned VMs. If false - return all VMs

Request

URL

get

https://cloud.vmwarehorizon.com/portal/v2/pools/{id}/template/{dTemplateId}/vms

Copy

Path Parameters

string

dTemplateId Required

dTemplateId

string

id Required

Query Parameters

boolean

excludeAssignedVms Optional

excludeAssignedVms

string

org_id Optional

org_id

string

page Optional

Page number to retrieve.

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.

Bearer

Response

Response Body

200 OK

Returns PageInvVmWithUser of type */*

{
	"content": [
		{
			"agentStatus": "string",
			"agentVersion": "string",
			"cloudId": "string",
			"createdAt": "string",
			"error": "string",
			"id": "string",
			"image": "string",
			"lifecycleStatus": "string",
			"maxSessions": 0,
			"powerState": "string",
			"privateIp": "string",
			"publicKey": "string",
			"sessionPlacementStatus": "string",
			"sessions": [
				{
					"clientId": "string",
					"sessionStatus": "string",
					"sessionType": "APPLICATION",
					"templateType": "APP_CAPTURE_STUDIO",
					"userId": "string",
					"username": "string",
					"vmId": "string"
				}
			],
			"snapshotId": "string",
			"statusCode": 0,
			"timestamp": 0,
			"updatedAt": "string",
			"users": [
				{
					"userId": "string",
					"userName": "string"
				}
			],
			"vmFreeSessions": 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 InvVmWithUser

content Optional

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

ErrorResponse

404

Not found

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/portal/v2/pools/{id}/template/{dTemplateId}/vms

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

horizon-cloud-nextgen

Portal Operations

post

Create

delete

Delete Pool

delete

Delete V3 Pool

get

Get Pool

get

Get Pools

get

List All Apps For Pools

post

List App By ID For Pools

get

List VMS With User

patch

Patch Pool

put

Update Pool

List VMS With User

Request

URL

Path Parameters

Query Parameters

Authentication

Bearer

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Portal Operations

Was this page helpful?