VDI Host

List

Retrieve the host VM list in real-time.

GET/api/Provider/VM/VDIHost

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

namenullable string

Name of the VM

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

templateIdinteger (int32)

Template ID

poolIdinteger (int32)

Pool ID

timeLastUsedstring (date-time)

Time when the object was last used.

timeCreatedstring (date-time)

Time when the object was created.

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/VM/VDIHost', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "siteId": 0,
    "name": "text",
    "id": "text",
    "providerId": 0,
    "templateId": 0,
    "poolId": 0,
    "timeLastUsed": "2024-12-21T14:16:57.382Z",
    "timeCreated": "2024-12-21T14:16:57.382Z"
  }
]

List by Provider ID

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

GET/api/Provider/{providerId}/VM/VDIHost

Path parameters

providerId*integer (int32)

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

Response

200401404

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

namenullable string

Name of the VM

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

templateIdinteger (int32)

Template ID

poolIdinteger (int32)

Pool ID

timeLastUsedstring (date-time)

Time when the object was last used.

timeCreatedstring (date-time)

Time when the object was created.

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/VDIHost', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "siteId": 0,
    "name": "text",
    "id": "text",
    "providerId": 0,
    "templateId": 0,
    "poolId": 0,
    "timeLastUsed": "2024-12-21T14:16:57.382Z",
    "timeCreated": "2024-12-21T14:16:57.382Z"
  }
]

Get

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

GET/api/Provider/{providerId}/VM/{id}/VDIHost

Path parameters

providerId*integer (int32)

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

id*string

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

Response

200401404

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

namenullable string

Name of the VM

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

templateIdinteger (int32)

Template ID

poolIdinteger (int32)

Pool ID

timeLastUsedstring (date-time)

Time when the object was last used.

timeCreatedstring (date-time)

Time when the object was created.

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/{id}/VDIHost', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "siteId": 0,
  "name": "text",
  "id": "text",
  "providerId": 0,
  "templateId": 0,
  "poolId": 0,
  "timeLastUsed": "2024-12-21T14:16:57.382Z",
  "timeCreated": "2024-12-21T14:16:57.382Z"
}

Delete

Remove a RAS Guest Agent from a host VM, thus making it a plain VM, not a host VM recognized by Parallels RAS.

DELETE/api/Provider/{providerId}/VM/{id}/VDIHost

Path parameters

providerId*integer (int32)

The ID of the Provider server where the target host VM resides.

id*string

The ID of the target host VM.

Query parameters

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/{id}/VDIHost', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}