[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Create Spec
DescriptionCreates a spec when assigned user selects to launch the entitlement. Spec contains broker url, launch url and token info.
Request
URLURL
https://cloud.vmwarehorizon.com/portal/v1/users/spec
Request Body
Request Body
{
"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
string
sessionId
Optional
ID of the session to resume
string
templateId
Optional
Template ID
string
vmId
Optional
VM ID
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse 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
404
Not Found
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
This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: specReq
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
On This Page
Portal Operations
get
get
post
post
get
get
get
post
post