How to delete a hypervisor in Citrix Virtual Apps and Desktops
Use REST APIs to delete a hypervisor and related resource pools within your Citrix Virtual Apps and Desktops site.
Follow the prerequisites and examples to get started with this API.
You can make API requests using the PowerShell code, C# code, Python, or any tool that supports invoking the REST API.
Prerequisites to delete a hypervisor in Citrix Virtual Apps and Desktops
- Read the Learning journey for Citrix Virtual Apps and Desktops APIs section to ensure that you have the
bearer token. - Get
siteidfrom How to get site id API. - Get
nameOrIdof the hypervisor from How to get all hypervisors API. - Invoke the API described in this document from a client host or from the API exploration tab to delete a hypervisor and related resource pools.
Delete a hypervisor in your site using any REST API tool
Learn from the following example to delete a hypervisor and related resource pools within your Citrix Virtual Apps and Desktops site using any REST API tool.
Request
DELETE https://[DdcServerAddress]/cvad/manage/hypervisors/{nameOrId} HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Authorization: CWSAuth bearer=<token-from-prerequisites>
Citrix-CustomerId: loy6oujtu6a4
Citrix-InstanceId: 22ded57c-0306-47e4-b6e8-fed6252759e1
<!--NeedCopy-->
Response
HTTP/1.1 204 NoContent
citrix-transactionid: 70b0d7d3...
content-Type: application/json; charset=utf-8
date: "Thu, 17 Sep 2020 03:08:08 GMT"
<!--NeedCopy-->
Delete a hypervisor in your site using PowerShell
Learn from the following example to delete a hypervisor and related resource pools within your Citrix Virtual Apps and Desktops site using any PowerShell code.
function DeleteHypervisor {
param (
[Parameter(Mandatory=$true)]
[string] $customerid,
[Parameter(Mandatory=$true)]
[string] $siteid,
[Parameter(Mandatory=$true)]
[string] $nameOrId,
[Parameter(Mandatory=$true)]
[string] $bearerToken
)
$requestUri = [string]::Format("https://[DdcServerAddress]/cvad/manage/hypervisors/{0}", $nameOrId)
$headers = @{
"Accept" = "application/json";
"Authorization" = "CWSAuth Bearer=$bearerToken";
"Citrix-CustomerId" = $customerid;
"Citrix-InstanceId" = $siteid;
}
$response = Invoke-RestMethod -Uri $requestUri -Method DELETE -Headers $headers
return $response
}
$customerId = "customer1"
$siteId = "61603f15-cdf9-4c7f-99ff-91636601a795"
$nameOrId = "56f1cbf3-1cc6-40cd-9c82-c95633ba88bb"
$bearerToken = "ey1.."
$response = DeleteHypervisor $customerid $siteid $nameOrId $bearerToken
<!--NeedCopy-->
Delete a hypervisor in your site using C# code
Learn from the following example to delete a hypervisor and related resource pools within your Citrix Virtual Apps and Desktops site using C# code.
public static async Task<string> DeleteHypervisor(
string customerid,
string siteid,
string nameOrId,
string bearerToken)
{
var requestUri = string.Format("https://[DdcServerAddress]/cvad/manage/hypervisors/{0}", nameOrId);
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Accept.ParseAdd("application/json");
client.DefaultRequestHeaders.Add("Citrix-CustomerId", customerid);
client.DefaultRequestHeaders.Add("Citrix-InstanceId", siteid);
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("CWSAuth Bearer=" + bearerToken);
var response = await client.DeleteAsync(requestUri);
if (response != null)
{
var content = await response.Content.ReadAsStringAsync();
return content;
}
return null;
}
}
<!--NeedCopy-->
Delete a hypervisor in your site using Python
Learn from the following example to delete a hypervisor and related resource pools within your Citrix Virtual Apps and Desktops site using Python.
import requests
def delete_hypervisor(bearerToken, customerid, siteid, nameOrId):
request_uri = "https://[DdcServerAddress]/cvad/manage/hypervisors/{0}".format(nameOrId)
headers = {
'Authorization': 'CWSAuth Bearer=%s' % bearerToken,
'Citrix-CustomerId': customerid,
'Citrix-InstanceId': siteid,
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.delete(request_uri, headers = headers)
return response.json()
<!--NeedCopy-->