Citrix DaaS REST APIs
How to get all hypervisors in Citrix DaaS
Use REST APIs to get all hypervisors in your Citrix DaaS (formerly Citrix Virtual Apps and Desktops service) 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 get all hypervisors
- Read the Get started with Citrix Cloud APIs section to ensure that you have the
bearer token. - Get
siteidfrom How to get site id API. - Invoke the API described in this document from a client host or from the API exploration tab to get all hypervisors in the site.
Get all hypervisors in your site using any REST API tool
Learn from the following example to get all hypervisors in your Citrix DaaS site using any REST API tool.
Request
GET https://api.cloud.com/cvad/manage/hypervisors 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 200 OK
citrix-transactionid: 06137dc7-193a-41d5-a1a4-317c20f46c85
content-Length: 423
content-Type: application/json; charset=utf-8
date: "Thu, 17 Sep 2020 02:48:23 GMT"
{
"Items": [
{
"ConnectionType": "AzureRM",
"Addresses": [
"https://management.azure.com/"
],
"InMaintenanceMode": false,
"PluginId": "AzureRmFactory",
"Scopes": [
{
"Id": "00000000...",
"Uid": null,
"Name": "All",
"Description": null,
"IsBuiltIn": true,
"IsAllScope": true,
"IsTenantScope": false,
"TenantId": null,
"TenantName": null
}
],
"Tenants": null,
"UsesCloudInfrastructure": false,
"Zone": {
"Id": "41e85452...",
"Uid": 4,
"Name": "My Resource Location"
},
"Id": "19ad12b0...",
"Name": "CVAD_APIs_CONN",
"XDPath": "XDHyp:\\Connections\\CVAD_APIs_CONN"
}
]
}
<!--NeedCopy-->
Get all hypervisors in your site using PowerShell
Learn from the following example to get all hypervisors in your Citrix DaaS site using any PowerShell code.
function GetHypervisors {
param (
[Parameter(Mandatory=$true)]
[string] $customerid,
[Parameter(Mandatory=$true)]
[string] $siteid,
[Parameter(Mandatory=$true)]
[string] $bearerToken
)
$requestUri = "https://api.cloud.com/cvad/manage/hypervisors"
$headers = @{
"Accept" = "application/json";
"Authorization" = "CWSAuth Bearer=$bearerToken";
"Citrix-CustomerId" = $customerid;
"Citrix-InstanceId" = $siteid;
}
$response = Invoke-RestMethod -Uri $requestUri -Method GET -Headers $headers
return $response
}
$customerid = "n2ypkklgy6cv"
$siteid = "12f7438-bf8e-42ba-b1b3-2eb75d098f57"
$bearerToken = "eyJ..."
$response = GetHypervisors $customerid $siteid $bearerToken
<!--NeedCopy-->
Get all hypervisors in your site using C# code
Learn from the following example to get all hypervisors in your Citrix DaaS site using any C# code.
public static async Task<string> GetHypervisors(
string customerid,
string bearerToken,
string siteid)
{
var requestUri = "https://api.cloud.com/cvad/manage/hypervisors";
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.GetAsync(requestUri);
if (response != null)
{
var content = await response.Content.ReadAsStringAsync();
return content;
}
return null;
}
}
<!--NeedCopy-->
Get all hypervisors in your site using Python
Learn from the following example to get all hypervisors in your Citrix DaaS site using Python.
import requests
def get_hypervisors(bearerToken, customerid, siteid):
request_uri = "https://api.cloud.com/cvad/manage/hypervisors"
headers = {
'Authorization': 'CWSAuth Bearer=%s' % bearerToken,
'Citrix-CustomerId': customerid,
'Citrix-InstanceId': siteid,
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.get(request_uri, headers = headers)
return response.json()
<!--NeedCopy-->
How to get all hypervisors in Citrix DaaS
Copied!
Failed!