Citrix Virtual Apps and Desktops REST APIs

How to create an application group in Citrix Virtual Apps and Desktops

Use REST APIs to create an application group in 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 create an application group in Citrix Virtual Apps and Desktops

Create an application group in your site using any REST API tool

Learn from the following example to create an application group in your Citrix Virtual Apps and Desktops site using any REST API tool.

Request

POST https://[DdcServerAddress]/cvad/manage/ApplicationGroups 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

{
    "Name": "AG01",
    "Description": "AG01",
    "DeliveryGroups": [],
    "IncludedUserFilterEnabled": false
}
<!--NeedCopy-->

Response

HTTP/1.1 200 OK
citrix-transactionid: f3bfca69...
content-Length: 812
content-Type: application/json; charset=utf-8
date: "Fri, 11 Dec 2020 09:07:12 GMT"

{
    "ApplicationCount": 0,
    "IncludedUsersFilterEnabled": false,
    "IncludedUsers": [],
    "SessionSharingEnabled": true,
    "TotalMachines": 0,
    "Id": "c1a0e0ee-1179-4666-a19f-86d8b0ce2fb6",
    "Uid": 26,
    "ContainerScopes": [],
    "Description": "AG01",
    "Enabled": true,
    "Name": "AG01",
    "Scopes": [
        {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Uid": null,
            "Name": "All",
            "Description": null,
            "IsBuiltIn": true,
            "IsAllScope": true,
            "IsTenantScope": false,
            "TenantId": null,
            "TenantName": null
        }
    ],
    "Tags": [],
    "Tenants": null,
    "NumApplications": 0,
    "NumMachines": 0,
    "NumMachinesWithTag": 0,
    "RestrictToTag": {
        "Id": null,
        "Uid": null,
        "Name": null
    },
    "DeliveryGroups": []
}
<!--NeedCopy-->

Create an application group in your site using PowerShell

Learn from the following example to create an application group in your Citrix Virtual Apps and Desktops site using any PowerShell code.

function CreateApplicationGroup {
    param (
        [Parameter(Mandatory=$true)]
        [string] $customerid,
        [Parameter(Mandatory=$true)]
        [string] $siteid,
        [Parameter(Mandatory=$true)]
        [string] $bearerToken,
        [Parameter(Mandatory=$true)]
        [string] $body
    )
    $requestUri = "https://[DdcServerAddress]/cvad/manage/ApplicationGroups"
    $headers = @{
        "Accept" = "application/json";
        "Content-Type"="application/json";
        "Authorization" = "CWSAuth Bearer=$bearerToken";
        "Citrix-CustomerId" = $customerid;
        "Citrix-InstanceId" = $siteid;
    }
    $response = Invoke-RestMethod -Uri $requestUri -Method POST -Headers $headers -Body $body 
    return $response
}

$customerId = "customer1"
$siteId = "61603f15-cdf9-4c7f-99ff-91636601a795"
$bearerToken = "ey1.."
$body = @"
{ 
    "Name": "AG01",
    "Description": "AG01",
    "DeliveryGroups": [],
    "IncludedUserFilterEnabled": false
}
"@
$response = CreateApplicationGroup $customerid $siteid $bearerToken $body
<!--NeedCopy-->

Create an application group in your site using C# code

Learn from the following example to create an application group in your Citrix Virtual Apps and Desktops site using any C# code.

public static async Task<string> CreateApplicationGroup(
    string customerid,
    string siteid,
    string bearerToken,
    CreateApplicationGroupRequestModel model)
{
    var requestUri = "https://[DdcServerAddress]/cvad/manage/ApplicationGroups"
    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 jsonBody = JsonConvert.SerializeObject(model, new JsonSerializerSettings
        {
            Converters = new JsonConverter[] { new StringEnumConverter() }
        });

        var response = await client.PostAsync(requestUri, new StringContent(jsonBody, Encoding.UTF8, "application/json"));

        if (response != null)
        {
            var content = await response.Content.ReadAsStringAsync();
            return content;
        }

        return null;
    }
}
<!--NeedCopy-->

Create an application group in your site using Python

Learn from the following example to create an application group in your Citrix Virtual Apps and Desktops site using Python.

import requests

def create_application_group(bearerToken, customerid, siteid):
    request_uri = "https://[DdcServerAddress]/cvad/manage/ApplicationGroups"
    headers = {
                'Authorization': 'CWSAuth Bearer=%s' % bearerToken,
                'Citrix-CustomerId': customerid,
                'Citrix-InstanceId': siteid,
                'Content-Type': 'application/json',
                'Accept': 'application/json'
              }
    payload = json.dumps({
        "Name": "AG01",
        "Description": "AG01",
        "DeliveryGroups": [],
        "IncludedUserFilterEnabled": false
    })

    response = requests.post(request_uri, headers = headers, verify = False, data = payload)

    return response.json()
<!--NeedCopy-->
Resources
Citrix Virtual Apps and Desktops REST APIs OpenAPI Specification
Copy Download
How to create an application group in Citrix Virtual Apps and Desktops