Citrix Virtual Apps and Desktops REST APIs

How to get all StoreFront servers in Citrix Virtual Apps and Desktops

Use REST APIs to get all StoreFront servers in your Citrix Virtual Apps and Desktops site. Storefront servers are Web servers that host Web based receivers.

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 StoreFront servers

Get all StoreFront servers in your site using any REST API tool

Learn from the following example to get all StoreFront servers in your Citrix Virtual Apps and Desktops site using any REST API tool.

Request

GET https://[DdcServerAddress]/cvad/manage/storefrontservers 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: 391197e9-6495-4a20-8d2c-c664c6b62eac
content-Length: 604
content-Type: application/json; charset=utf-8
date: "Thu, 20 Jan 2021 16:03:36 GMT"
Server: Citrix Systems, Inc.

{
    "Items": [
        {
            "Id": "1d405094-3abe-4ab9-b304-b21522bcd3e6",
            "Name": "My-SF-A",
            "Description": "Storefront Server A",
            "Url": "https://portal-a.mysite.com/Citrix/StoreWeb",
            "Enabled": true,
            "DesktopGroupRefCount": 1
        },
        {
            "Id": "5c796610-cb80-40ae-8378-5cbd5cefbd89",
            "Name": "My-SF-B",
            "Description": "Storefront Server B",
            "Url": "https://portal-b.mysite.com/Citrix/StoreWeb",
            "Enabled": true,
            "DesktopGroupRefCount": 1
        }
    ],
    "ContinuationToken": null,
    "TotalItems": 2
}
<!--NeedCopy-->

Get all StoreFront servers in your site using PowerShell

Learn from the following example to get all StoreFront servers in your Citrix Virtual Apps and Desktops site using any PowerShell code.

function GetAllStorefrontServers {
    param (
        [Parameter(Mandatory=$true)]
        [string] $customerid,
        [Parameter(Mandatory=$true)]
        [string] $siteid,
        [Parameter(Mandatory=$true)]
        [string] $bearerToken
    )
    $requestUri = "https://[DdcServerAddress]/cvad/manage/storefrontservers"
    $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 = GetAllStorefrontServers $customerid $siteid $bearerToken 
<!--NeedCopy-->

Get all StoreFront servers in your site using C# code

Learn from the following example to get all StoreFront servers in your Citrix Virtual Apps and Desktops site using any C# code.

public static async Task<string> GetAllStorefrontServers
    string customerid,
    string siteid,
    string bearerToken)
{
    var requestUri = "https://[DdcServerAddress]/cvad/manage/storefrontservers";
    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 StoreFront servers in your site using Python

Learn from the following example to get all StoreFront servers in your Citrix Virtual Apps and Desktops site using Python.

import requests 

def get_all_storefront_servers(bearerToken, customerid, siteid):
    request_uri = "https://[DdcServerAddress]/cvad/manage/storefrontservers"
    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-->
Resources
Citrix Virtual Apps and Desktops REST APIs OpenAPI Specification
Copy Download
How to get all StoreFront servers in Citrix Virtual Apps and Desktops