Citrix Virtual Apps and Desktops REST APIs
How to update a delivery group in Citrix Virtual Apps and Desktops
Use REST APIs to update a delivery 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 update a delivery 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
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 update a delivery group.
Update a delivery group in your site using any REST API tool
Learn from the following example to update a delivery group within your Citrix Virtual Apps and Desktops site using any REST API tool.
Request
PATCH https://[DdcServerAddress]/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
Citrix-InstanceId: 22ded57c-0306-47e4-b6e8-fed6252759e1
{
"Description": "Test",
"Enabled": true,
"SecureIcaEnabled": false,
"TimeZone": "UTC",
"RequireUserHomeZone": false,
"DeliveryType": "DesktopsAndApps",
"PrelaunchSettings": {
"Enabled": false,
"MaxAverageLoadThreshold": 0,
"MaxLoadPerMachineThreshold": 0,
"MaxTimeBeforeTerminateMinutes": 480,
"IncludedUsers": [],
"IncludedUserFilterEnabled": false
}
}
<!--NeedCopy-->
Response
HTTP/1.1 204 NoContent
citrix-transactionid: c93f3d9e...
content-Type: application/json; charset=utf-8
date: "Fri, 25 Sep 2020 08:05:01 GMT"
<!--NeedCopy-->
Update a delivery group in your site using PowerShell
Learn from the following example to update a delivery group within your Citrix Virtual Apps and Desktops site using any PowerShell code.
function PatchDeliveryGroup {
param (
[Parameter(Mandatory=$true)]
[string] $customerid,
[Parameter(Mandatory=$true)]
[string] $siteid,
[Parameter(Mandatory=$true)]
[string] $nameOrId,
[Parameter(Mandatory=$true)]
[string] $bearerToken,
[Parameter(Mandatory=$true)]
[string] $body
)
$requestUri = [string]::Format("https://[DdcServerAddress]/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 PATCH -Headers $headers -Body $body
return $response
}
$customerId = "customer1"
$siteId = "61603f15-cdf9-4c7f-99ff-91636601a795"
$nameOrId = "56f1cbf3-1cc6-40cd-9c82-c95633ba88bb"
$bearerToken = "ey1.."
$body = @"
{
"Description": "Test",
"Enabled": true,
"SecureIcaEnabled": false,
"TimeZone": "UTC",
"RequireUserHomeZone": false,
"DeliveryType": "DesktopsAndApps",
"PrelaunchSettings": {
"Enabled": false,
"MaxAverageLoadThreshold": 0,
"MaxLoadPerMachineThreshold": 0,
"MaxTimeBeforeTerminateMinutes": 480,
"IncludedUsers": [],
"IncludedUserFilterEnabled": false
}
}
"@
$response = PatchDeliveryGroup $customerid $siteid $nameOrId $bearerToken $body
<!--NeedCopy-->
Update a delivery group in your site using C# code
Learn from the following example to update a delivery group within your Citrix Virtual Apps and Desktops site using any C# code.
public static async Task<string> PatchDeliveryGroup(
string customerid,
string siteid,
string nameOrId,
string bearerToken,
EditDeliveryGroupRequestModel model)
{
var requestUri = string.Format("https://[DdcServerAddress]/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 jsonBody = JsonConvert.SerializeObject(model, new JsonSerializerSettings
{
Converters = new JsonConverter[] { new StringEnumConverter() }
});
var response = await client.PatchAsync(requestUri, new StringContent(jsonBody, Encoding.UTF8, "application/json"));
if (response != null)
{
var content = await response.Content.ReadAsStringAsync();
return content;
}
return null;
}
}
<!--NeedCopy-->
Update a delivery group in your site using Python
Learn from the following example to update a delivery group within your Citrix Virtual Apps and Desktops site using Python code.
import requests
def patch_delivery_group(bearerToken, customerid, siteid, nameOrId):
request_uri = "https://[DdcServerAddress]/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'
}
payload = json.dumps({
"Description": "Test",
"Enabled": true,
"SecureIcaEnabled": false,
"TimeZone": "UTC",
"RequireUserHomeZone": false,
"DeliveryType": "DesktopsAndApps",
"PrelaunchSettings": {
"Enabled": false,
"MaxAverageLoadThreshold": 0,
"MaxLoadPerMachineThreshold": 0,
"MaxTimeBeforeTerminateMinutes": 480,
"IncludedUsers": [],
"IncludedUserFilterEnabled": false
}
})
response = requests.patch(request_uri, headers = headers, verify = False, data = payload)
return response.json()
<!--NeedCopy-->
How to update a delivery group in Citrix Virtual Apps and Desktops
Copied!
Failed!