Registry | Parallels REST API

Parallels REST API

SupportDocumentation

List

Retrieves Registry.

get

/api/AVD/HostPool/{id}/Optimization/Registry

Path parameters

idinteger · int32required

The ID of the optimization setting to retrieve the registry.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/HostPool/{id}/Optimization/Registry'

200

401

404

[
  {
    "id": 1,
    "action": [
      "0 = Add",
      "1 = Modify",
      "2 = Delete"
    ],
    "registryName": "text",
    "dwordValue": 1,
    "displayName": "text",
    "hiveType": [
      "0 = HKEY_CURRENT_CONFIG",
      "1 = HKEY_USERS",
      "2 = HKEY_LOCAL_MACHINE",
      "3 = HKEY_CLASSES_ROOT"
    ],
    "path": "text",
    "regType": [
      "0 = REG_SZ",
      "1 = REG_DWORD",
      "2 = REG_QWORD",
      "3 = REG_MULTI_SZ",
      "4 = REG_EXPAND_SZ"
    ],
    "stringValue": "text"
  }
]

Success

Add

Adds Registry to the optimization.

post

/api/AVD/HostPool/{id}/Optimization/Registry

Path parameters

idinteger · int32required

The ID of the optimization to retrieve the registry.

Body

actionstring · enum

<para type="synopsis">The action type for add registry entry</para> <para type="description"></para>

Options: 0 = Add,1 = Modify,2 = Delete

registryNamestring | nullable

dwordValueinteger · int32

<para type="synopsis">Value</para> <para type="description"></para>

displayNamestring | nullablerequired

<para type="synopsis">Display Name</para> <para type="description"></para>

hiveTypestring · enum

<para type="synopsis">The hive type for add registry entry</para> <para type="description"></para>

Options: 0 = HKEY_CURRENT_CONFIG,1 = HKEY_USERS,2 = HKEY_LOCAL_MACHINE,3 = HKEY_CLASSES_ROOT

pathstring | nullablerequired

regTypestring · enum

<para type="synopsis">The value type for add registry entry</para> <para type="description"></para>

Options: 0 = REG_SZ,1 = REG_DWORD,2 = REG_QWORD,3 = REG_MULTI_SZ,4 = REG_EXPAND_SZ

stringValuestring | nullable

<para type="synopsis">String Value</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/HostPool/{id}/Optimization/Registry' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "action": [
      "0 = Add",
      "1 = Modify",
      "2 = Delete"
    ],
    "registryName": "text",
    "dwordValue": 1,
    "displayName": "text",
    "hiveType": [
      "0 = HKEY_CURRENT_CONFIG",
      "1 = HKEY_USERS",
      "2 = HKEY_LOCAL_MACHINE",
      "3 = HKEY_CLASSES_ROOT"
    ],
    "path": "text",
    "regType": [
      "0 = REG_SZ",
      "1 = REG_DWORD",
      "2 = REG_QWORD",
      "3 = REG_MULTI_SZ",
      "4 = REG_EXPAND_SZ"
    ],
    "stringValue": "text"
  }'

201

401

404

409

No body

Created

Delete

Remove Registry Image Optimization Object.

delete

/api/AVD/HostPool/{id}/Optimization/Registry

Path parameters

idinteger · int32required

Id Of the Optimization Settings to remove the registry object.

Body

registryIdinteger · int32required

<para type="synopsis">Registry Id</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/HostPool/{id}/Optimization/Registry' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "registryId": 1
  }'

204

401

404

No body

No Content