Members | Parallels REST API

Parallels REST API

SupportDocumentation

Get

get

Retrieve a VDI Host Pool Member from a VDI Host Pool.

Path parameters

vdiHostPoolIdinteger · int32Required

The VDI Host Pool ID.

idinteger · int32Required

The VDI Host Pool Member ID.

Responses

application/json; api-version=1.0

objectOptional

VDI Host Pool Member

application/json; api-version=1.0

get

GET /api/VDI/HostPool/{vdiHostPoolId}/Members/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "name": "text",
  "type": [
    "0 = AllHostsInProvider",
    "2 = Host",
    "3 = NativePool",
    "5 = Template",
    "7 = TemplateVersion"
  ],
  "providerId": 1
}

Delete

delete

Remove a VDI Host Pool Member from a VDI Host Pool.

Path parameters

vdiHostPoolIdinteger · int32Required

The VDI Host Pool ID.

idinteger · int32Required

The VDI Host Pool Member ID.

Responses

application/json; api-version=1.0

delete

DELETE /api/VDI/HostPool/{vdiHostPoolId}/Members/{id} HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve the list of VDI Host Pool Members from a VDI Host Pool.

Path parameters

vdiHostPoolIdinteger · int32Required

The VDI Host Pool ID.

Responses

application/json; api-version=1.0

object[]Optional

VDI Host Pool Member

application/json; api-version=1.0

get

GET /api/VDI/HostPool/{vdiHostPoolId}/Members HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "type": [
      "0 = AllHostsInProvider",
      "2 = Host",
      "3 = NativePool",
      "5 = Template",
      "7 = TemplateVersion"
    ],
    "providerId": 1
  }
]

Add

post

Add one VDI Host Pool Member to an existing VDI Host Pool.

Path parameters

vdiHostPoolIdinteger · int32Required

The VDI Host Pool ID.

Query parameters

noInstallbooleanOptional

If passed agent will not be installed on VM

usernamestringOptional

An administrator account for push installing the RAS Guest Agent in the VM.

passwordstringOptional

The password of the account specified in the Username parameter.

Body

Add a VDI Host Pool member

typestring · enumRequired

VDI Host Pool Member Type

Available options:

namestring | nullableRequired

The VDI Host Pool Member Name.

providerIdinteger · int32 | nullableOptional

The VDI Host Pool Member Provider ID. This parameter is only accepted with Types: ALLGUESTSONPROVIDER, GUEST or NATIVEPOOL.

vmIdstring | nullableOptional

The VDI Host Pool Member Guest ID. This parameter is only accepted with Type: GUEST.

nativePoolIdstring | nullableOptional

The VDI Host Pool Member Native Pool ID. This parameter is only accepted with Type: NATIVEPOOL.

noInstallbooleanOptional

Specifies not to install the RAS Guest Agent on the server. If this parameter is omitted, the agent will be push installed in the VM using your RAS admin credentials. To specify different credentials for push installation, use the Username and Password parameters. This parameter can be used in situations when the RAS Guest Agent is already installed in a VM, but the VM is powered down. By including this parameter, you will simply power up the VM and make it available for Parallels RAS operations.

Default: false

vmIdsstring[] | nullableOptional

The VDI Host Pool Member Desktops IDs. This parameter is only accepted with Type: ALLDESKTOPSONPROVIDER.

Responses

application/json; api-version=1.0

post

POST /api/VDI/HostPool/{vdiHostPoolId}/Members HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 199

{
  "type": [
    "0 = AllHostsInProvider",
    "2 = Host",
    "3 = NativePool",
    "5 = Template",
    "7 = TemplateVersion"
  ],
  "name": "text",
  "providerId": 1,
  "vmId": "text",
  "nativePoolId": "text",
  "noInstall": true,
  "vmIds": [
    "text"
  ]
}

No content