Citrix Virtual Apps and Desktops REST APIs
How to delete an application group in Citrix Virtual Apps and Desktops
Use REST APIs to delete an application group within 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 delete an application group
- Read the Learning journey for Citrix Virtual Apps and Desktops APIs section to ensure that you have the
bearer token. - Get
siteidfrom How to get site id API. - Get
pathOrIdof the application group from How to get all application groups API. - Invoke the API described in this document from a client host or from the API exploration tab to delete an application group.
Delete an application group from your site using any REST API tool
Learn from the following example to delete an application group within your Citrix Virtual Apps and Desktops site using any REST API tool.
Request
DELETE https://[DdcServerAddress]/cvad/manage/ApplicationGroups/{nameOrId} 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 204 NoContent
citrix-transactionid: 22785383...
content-Type: application/json; charset=utf-8
date: "Fri, 11 Dec 2020 10:20:50 GMT"
<!--NeedCopy-->
Delete an application group from your site using PowerShell
Learn from the following example to delete an application group within your Citrix Virtual Apps and Desktops site using PowerShell.
function DeleteApplicationGroup {
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/ApplicationGroups/{0}", $nameOrId)
$headers = @{
"Accept" = "application/json";
"Authorization" = "CWSAuth Bearer=$bearerToken";
"Citrix-CustomerId" = $customerid;
"Citrix-InstanceId" = $siteid;
}
$response = Invoke-RestMethod -Uri $requestUri -Method DELETE -Headers $headers
return $response
}
$customerId = "customer1"
$siteId = "61603f15-cdf9-4c7f-99ff-91636601a795"
$nameOrId = "56f1cbf3-1cc6-40cd-9c82-c95633ba88bb"
$bearerToken = "ey1.."
$response = DeleteApplicationGroup $customerid $siteid $nameOrId $bearerToken
<!--NeedCopy-->
Delete an application group from your site using C# code
Learn from the following example to delete an application group within your Citrix Virtual Apps and Desktops site using any C# code.
public static async Task<string> DeleteApplicationGroup(
string customerid,
string siteid,
string nameOrId,
string bearerToken)
{
var requestUri = string.Format("https://[DdcServerAddress]/cvad/manage/ApplicationGroups/{0}", 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.DeleteAsync(requestUri);
if (response != null)
{
var content = await response.Content.ReadAsStringAsync();
return content;
}
return null;
}
}
<!--NeedCopy-->
Delete an application group from your site using Python
Learn from the following example to delete an application group within your Citrix Virtual Apps and Desktops site using Python.
import requests
def delete_application_group(bearerToken, customerid, siteid, nameOrId):
request_uri = "https://[DdcServerAddress]/cvad/manage/ApplicationGroups/{0}".format(nameOrId)
headers = {
'Authorization': 'CWSAuth Bearer=%s' % bearerToken,
'Citrix-CustomerId': customerid,
'Citrix-InstanceId': siteid,
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.delete(request_uri, headers = headers)
return response.json()
<!--NeedCopy-->
How to delete an application group in Citrix Virtual Apps and Desktops
In this article
Copied!
Failed!