WindowsComponent | Parallels REST API

Parallels REST API

SupportDocumentation

List

get

Retrieve Windows Component Custom

Path parameters

idinteger · int32required

The ID of the optimization setting to retrieve the windows component custom list.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/Optimization/WindowsComponent'

200

401

404

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "componentName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Success

Add

post

Adds a Windows Component Custom to optimization.

Path parameters

idinteger · int32required

The ID of the Optimization settings to add the windows component custom.

Body

aliasesstring | nullable

<para type="synopsis">Windows Components Alias</para> <para type="description"></para>

displayNamestring | nullable

<para type="synopsis">Windows Components Diplay Name</para> <para type="description"></para>

componentNamestring | nullable

<para type="synopsis">Windows Components Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/Optimization/WindowsComponent' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "aliases": "text",
    "displayName": "text",
    "componentName": "text"
  }'

201

401

404

409

No body

Created

Delete

delete

Removes Windows Component Custom From Optimization.

Path parameters

idinteger · int32required

The ID of the optimization setting to remove the windows component custom.

Body

componentNamestring | nullable

<para type="synopsis">Windows Component Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/Optimization/WindowsComponent' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "componentName": "text"
  }'

204

401

404

No body

No Content