AVD Host | Parallels REST API

Parallels REST API

SupportDocumentation

List

get

Retrieve the host VM list in real-time.

Query parameters

SiteIdinteger · int32Optional

Site ID from which to retrieve the host VM list (optional).

Responses

application/json; api-version=1.0

object[]Optional

AVD Host

application/json; api-version=1.0

get

GET /api/Provider/VM/AVDHost HTTP/1.1
Host: 
Accept: */*

[
  {
    "siteId": 1,
    "id": "text",
    "providerId": 1,
    "host": "text",
    "avdAgent": "text",
    "hostPool": "text",
    "workspace": "text",
    "location": "text",
    "resourceGroup": "text"
  }
]

List by Provider ID

get

Retrieve the host VM list from a Provider in real-time.

Path parameters

providerIdinteger · int32Required

The ID of a Provider server from which to obtain the VM list.

Responses

application/json; api-version=1.0

object[]Optional

AVD Host

application/json; api-version=1.0

get

GET /api/Provider/{providerId}/VM/AVDHost HTTP/1.1
Host: 
Accept: */*

[
  {
    "siteId": 1,
    "id": "text",
    "providerId": 1,
    "host": "text",
    "avdAgent": "text",
    "hostPool": "text",
    "workspace": "text",
    "location": "text",
    "resourceGroup": "text"
  }
]

Get

get

Retrieve the specified host VM from a Provider in real-time.

Path parameters

providerIdinteger · int32Required

The ID of a Provider server from which to retrieve the specified VM.

idstringRequired

The ID of a host VM for which to retrieve the information.

Responses

application/json; api-version=1.0

objectOptional

AVD Host

application/json; api-version=1.0

get

GET /api/Provider/{providerId}/VM/{id}/AVDHost HTTP/1.1
Host: 
Accept: */*

{
  "siteId": 1,
  "id": "text",
  "providerId": 1,
  "host": "text",
  "avdAgent": "text",
  "hostPool": "text",
  "workspace": "text",
  "location": "text",
  "resourceGroup": "text"
}