Citrix DaaS REST APIs
How to delete a delivery group in Citrix DaaS
Use REST APIs to delete a delivery group from your Citrix DaaS (formerly Citrix Virtual Apps and Desktops service) 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 a delivery group
- Read the Get started with Citrix Cloud APIs section to ensure that you have the
bearer token. - Get
siteidfrom How to get site id API. - Get
nameOrIdof the delivery group from How to get delivery groups API. - Invoke the API described in this document from a client host or from the API exploration tab to delete a delivery group.
Delete a delivery group from your site using any REST API tool
Learn from the following example to delete a delivery group from your Citrix DaaS site using any REST API tool.
Request
DELETE https://api.cloud.com/cvad/manage/DeliveryGroups/{nameOrId} HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Authorization: CWSAuth bearer=<token-from-prerequisites>
Citrix-CustomerId: loy6oujtu6a4
<!--NeedCopy-->
Response
HTTP/1.1 202 Accepted
citrix-transactionid: 6cdd2f60...
content-Type: application/json; charset=utf-8
date: "Fri, 25 Sep 2020 08:10:56 GMT"
<!--NeedCopy-->
Delete a delivery group from your site using PowerShell
Learn from the following example to delete a delivery group from your Citrix DaaS site using any PowerShell code.
function DeleteDeliveryGroup {
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://api.cloud.com/cvad/manage/DeliveryGroups/{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 = DeleteDeliveryGroup $customerid $siteid $nameOrId $bearerToken
<!--NeedCopy-->
Delete a delivery group from your site using C# code
Learn from the following example to delete a delivery group from your Citrix DaaS site using any C# code.
public static async Task<string> DeleteDeliveryGroup(
string customerid,
string siteid,
string nameOrId,
string bearerToken)
{
var requestUri = string.Format("https://api.cloud.com/cvad/manage/DeliveryGroups/{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 a delivery group from your site using Python
Learn from the following example to delete a delivery group from your Citrix DaaS site using Python.
import requests
def delete_delivery_group(bearerToken, customerid, siteid, nameOrId):
request_uri = "https://api.cloud.com/cvad/manage/DeliveryGroups/{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 a delivery group in Citrix DaaS
Copied!
Failed!