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

Create Spec

Description

Creates a spec when assigned user selects to launch the entitlement. Spec contains broker url, launch url and token info.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/portal/v1/users/spec
Copy

Request Body

Request Body

DesktopSpecReq of mimetype application/json Required

specReq

{
	"appName": "Notepad",
	"clientId": "clientid",
	"entitlementId": "ent-id-12345",
	"nativeClient": false,
	"poolId": "pool-id-12345",
	"protocol": {
		"defaultProtocol": false,
		"name": "BLAST"
	},
	"sessionId": "abcd",
	"templateId": "6012393dfdfdf8",
	"vmId": "ded1000"
}
string
appName Optional

App Name to launch


string
clientId Optional

Client ID


string
entitlementId Optional

Entitlement ID


boolean
nativeClient Optional

Launch client - HTML or native client


string
poolId Optional

Pool ID


protocol Optional

string
sessionId Optional

ID of the session to resume


string
templateId Optional

Template ID


string
vmId Optional

VM ID

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns DesktopSpecJwt of type application/json
{
	"brokerUrl": "https://broker.vwmare.com",
	"id": "ent-and-123",
	"launchURL": "https://broker.vwmare.com/launch?dspec=jwt",
	"specJwt": "jwt"
}
string
brokerUrl Optional

Broker/Connection Service URL


string
id Optional

LaunchId i.e. EntitlementId or sessionId which this DSpec represents


string
launchURL Optional

Desktop launch URL


string
specJwt Optional

Desktop spec JWT

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


412

Precondition Failed

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"appName":"Notepad","clientId":"clientid","entitlementId":"ent-id-12345","nativeClient":false,"poolId":"pool-id-12345","protocol":{"defaultProtocol":false,"name":"BLAST"},"sessionId":"abcd","templateId":"6012393dfdfdf8","vmId":"ded1000"}' https://cloud.vmwarehorizon.com/portal/v1/users/spec
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: specReq


Feedback

Was this page helpful?