VDI Host
Retrieve the host VM list in real-time.
Site ID from which to retrieve the host VM list (optional).
The ID of the VDI Template for which to retrieve the hosts of (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the host list will be filtered with those with an assigned user.
GET /api/Provider/VM/VDIHost HTTP/1.1
Host:
Accept: */*
[
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"templateId": 1,
"poolId": 1,
"timeLastUsed": "2025-07-07T18:37:18.141Z",
"timeCreated": "2025-07-07T18:37:18.141Z"
}
]Retrieve the host VM list from a Provider in real-time.
The ID of a Provider server from which to obtain the VM list.
GET /api/Provider/{providerId}/VM/VDIHost HTTP/1.1
Host:
Accept: */*
[
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"templateId": 1,
"poolId": 1,
"timeLastUsed": "2025-07-07T18:37:18.141Z",
"timeCreated": "2025-07-07T18:37:18.141Z"
}
]Retrieve the specified host VM from a Provider in real-time.
The ID of a Provider server from which to retrieve the specified VM.
The ID of a host VM for which to retrieve the information.
GET /api/Provider/{providerId}/VM/{id}/VDIHost HTTP/1.1
Host:
Accept: */*
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"templateId": 1,
"poolId": 1,
"timeLastUsed": "2025-07-07T18:37:18.141Z",
"timeCreated": "2025-07-07T18:37:18.141Z"
}Remove a RAS Guest Agent from a host VM, thus making it a plain VM, not a host VM recognized by Parallels RAS.
The ID of the Provider server where the target host VM resides.
The ID of the target host VM.
If this parameter is included, the VDI Guest agent will not be uninstalled from the server. To uninstall the agent, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials if needed using the Username and Password parameters.
An administrator account to remotely uninstall the RAS Guest Agent from the VM. If this parameter is omitted, your RAS admin username and password will be used by default.
The password of the account specified in the Username parameter.
DELETE /api/Provider/{providerId}/VM/{id}/VDIHost HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?