Catalog service Quick Deploy APIs
How to get details of all published desktops
Use REST APIs to get details of all desktops published for a catalog in your Azure account.
You can make API requests using the PowerShell code, C# code, or any tool that supports invoking the REST API.
Steps to get details of all published desktops for a catalog in Azure account
To get details of all desktops published for a catalog in your Azure account, use the following procedure:
- Read the Get started with Citrix Cloud APIs section to ensure that you have the
customerIdandbearer token. - Get the
siteidfrom How to get a site ID API. - If you do not have the
catalogId, see how to get details of all catalogs to get the details of all your catalogs. - Use the API in this document to get details of all desktops for a catalog.
Get details of all published desktops for a catalog in Azure account using any REST API tool
Learn from the following example to get details of all desktops published for a catalog in your Azure account using any REST API tool.
Request
GET https://api.cloud.com/catalogservice/{customerId}/{siteId}/catalogs/{catalogId}/desktops HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: CwsAuth bearer=<token-from-prerequisites>
<!--NeedCopy-->
Response
HTTP/1.1 200 OK
citrix-transactionid: 80699539-ae66-4eb7-ae67-370606d12766
content-Length: 6676
content-Type: application/json; charset=utf-8
date: "Tue, 26 September 2017 19:20:13 GMT"
{
"items": [
{
"state": "Published",
"id": "21985b06-5a59-4641-9c92-5f8b4aff7ae5",
"name": "Finance-desktop",
"description": "Virtual Desktop for Finance department."
},
}
<!--NeedCopy-->
Interpreting the response
The response is a JSON with a list of all your published desktops for the catalog.
| Property name | Description |
|---|---|
| state | Publish state of the desktop. This is always set to Published. |
| id | The ID of the desktop. This is the ID to pass to any API that accepts an desktopId. |
| name | The name of the desktop. |
| description | This is the description that shows catalog details. |
Get details of all published desktops for a catalog in Azure account using PowerShell
Learn from the following example to get details of all desktops published for a catalog in your Azure account using PowerShell code.
function GetCatalogDesktops {
param (
[Parameter(Mandatory=$true)]
[string] $customerId,
[Parameter(Mandatory=$true)]
[string] $siteId,
[Parameter(Mandatory=$true)]
[string] $catalogId,
[Parameter(Mandatory=$true)]
[string] $bearerToken
)
$requestUri = [string]::Format("https://api.cloud.com/catalogservice/{0}/{1}/catalogs/{2}/desktops", $customerId, $siteId, $catalogId)
$headers = @{"Accept"="application/json";
"Authorization"="CwsAuth bearer=$bearerToken"}
$response = Invoke-RestMethod -Uri $requestUri -Method GET -Headers $headers
return $response
}
$customerId = "customer1" #Replace with your customerId
$siteId = "61603f15-cdf9-4c7f-99ff-91636601a795" #Replace with your site ID
$catalogId = "8d352ba7-1917-41c3-95e5-50f436be8968" #Replace with your catalog ID
$bearerToken = "ey1.." #See Prerequisites for all API calls section for a sample of how to get your bearer token
$response = GetCatalogDesktops $customerId $siteId $catalogId $bearerToken
<!--NeedCopy-->
Get details of all published desktops for a catalog in Azure account using C# code
Learn from the following example to get details of all desktops published for a catalog in your Azure account using C# code.
public static async Task<string> GetCatalogDesktops(
string customerId,
string siteId,
string catalogId,
string bearerToken)
{
var requestUri = string.Format("https://api.cloud.com/catalogservice/{0}/{1}/catalogs/{2}/desktops", customerId, siteId, catalogId);
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Accept.ParseAdd("application/json");
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("CwsAuth", "Bearer=" + bearerToken);
var response = await client.GetAsync(requestUri);
if (response != null)
{
var content = await response.Content.ReadAsStringAsync();
// Parsing the JSON content is left as an exercise to the reader.
// Consult Json.NET documentation on newtonsoft.com for more information.
return content;
}
return null;
}
}
<!--NeedCopy-->
How to get details of all published desktops
In this article
- Steps to get details of all published desktops for a catalog in Azure account
- Get details of all published desktops for a catalog in Azure account using any REST API tool
- Get details of all published desktops for a catalog in Azure account using PowerShell
- Get details of all published desktops for a catalog in Azure account using C# code
Copied!
Failed!