Assignment | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Delete

delete

Remove a host assignment.

Path parameters

providerIdinteger · int32required

The ID of the Provider server on which the target Host resides.

vmIdstringrequired

The ID of the host VM.

Query parameters

siteIdinteger · int32optional

Site ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Provider/{providerId}/VM/{vmId}/VDIHost/Assignment'

204

401

404

No Content

List

get

Retrieve a list of assigned hosts.

Query parameters

siteIdinteger · int32optional

Site ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider/VM/VDIHost/Assignment'

204

401

404

No Content

Update

put

Modify a host assignment.

Path parameters

providerIdinteger · int32required

The ID of the Provider server on which the target Host resides.

vmIdstringrequired

The ID of the host VM.

Query parameters

siteIdinteger · int32optional

Site ID.

Body

Update persistence configuration of the VDI Host

userstring | nullableoptional

The name of the user account to which to assign the Host.

devicestring | nullableoptional

The name of the device to which to assign the Host.

sidstring | nullableoptional

The SID of the user account to which to assign the Host.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Provider/{providerId}/VM/{vmId}/VDIHost/Assignment' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "user": "text",
    "device": "text",
    "sid": "text"
  }'

204

401

404

No Content