Citrix Virtual Apps and Desktops REST APIs

How to get delivery groups from a StoreFront server

Use REST APIs to get to get delivery groups from a StoreFront server.

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 delivery groups from a StoreFront server

Get delivery groups from a StoreFront server using any REST API tool

Learn from the following example to get delivery groups from a StoreFront server using any REST API tool.

Request

GET https://[DdcServerAddress]/cvad/manage/StorefrontServers/{nameOrId}/DeliveryGroups 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

Response

HTTP/1.1 200 OK citrix-transactionid: ba78d60e-eb03-4e15-83fb-55ee32be61be content-Length: 203 content-Type: application/json; charset=utf-8 date: "Thu, 21 Jan 2021 13:21:57 GMT" { "Items": [ { "DeliveryGroupUid": 2, "DeliveryGroupName": "My_Common_Apps_DG" }, { "DeliveryGroupUid": 3, "DeliveryGroupName": "My_Special_Apps_DG" } ] }

Get delivery groups from a StoreFront server using PowerShell

Learn from the following example to get delivery groups from a StoreFront server using any PowerShell code.

function GetStorefrontServerDeliveryGroups { 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/storefrontservers/{0}/deliverygroups", $nameOrId) $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 = "customer1" $siteId = "61603f15-cdf9-4c7f-99ff-91636601a795" $nameOrId = "56f1cbf3-1cc6-40cd-9c82-c95633ba88bb" $bearerToken = "ey1.." $response = GetStorefrontServerDeliveryGroups $customerid $siteid $nameOrId $bearerToken

Get delivery groups from a StoreFront server using C# code

Learn from the following example to get delivery groups from a StoreFront server using any C# code.

public static async Task<string> GetStorefrontServerDeliveryGroups( string customerid, string siteid, string nameOrId, string bearerToken) { var requestUri = string.Format("https://[DdcServerAddress]/cvad/manage/storefrontservers/{0}/deliverygroups", 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.GetAsync(requestUri); if (response != null) { var content = await response.Content.ReadAsStringAsync(); return content; } return null; } }

Get delivery groups from a StoreFront server using Python

Learn from the following example to get delivery groups from a StoreFront server using Python.

import requests def get_storefront_server_delivery_groups(bearerToken, customerid, siteid, nameOrId): request_uri = "https://[DdcServerAddress]/cvad/manage/storefrontservers/{0}/deliverygroups".format(nameOrId) 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()
Resources
Citrix Virtual Apps and Desktops REST APIs OpenAPI Specification
Copy Download
How to get delivery groups from a StoreFront server