Citrix DaaS REST APIs

Release notes

September 2024

Change Type API Summary
Addition GET /AppVPackages/{id}/Applications/{appId}/FileTypes Get the fileTypes for an application within a package within the site.
Addition GET /Identity/serviceAccount/{serviceAccountUid}/testReport Get the most recent test report for a service account.
Addition POST /$checkObjectNameExists Check for the existence of an object.
Addition POST /DeliveryGroups/$GetFileTypes Returns the file type associations the system imports from worker machines in the specified delivery group.
Addition POST /Identity/serviceAccount/{serviceAccountUid}/$test Run tests on a service account and create a test report.
Addition POST /MachineCatalogs/{nameOrId}/$export Exports a MCS machine catalog.
Update GET /DeliveryGroups/{nameOrId}/TestReport Get the most recent test report of a delivery group.
Update GET /gpo/filterDefinitions Get all filter definitions.
Update GET /Jobs/{id} Get the details of a single job.
Update PATCH /Identity/ServiceAccount/{serviceAccountUid} Set properties of an existing service account.
Update POST /$GetHypervisor Get a hypervisor details without creating persistent connection.
Update POST /Admin/Scopes Create a new admin scope.
Update POST /ApplicationGroups/{nameOrId}/Applications Add applications to the application group.
Update POST /Applications/$search Perform an advanced search for applications.
Update POST /ConfigLog/Operations/$search Perform an advanced search for configuration log entries.
Update POST /hypervisors/{nameOrId}/allResources/$search Search the resources within a hypervisor.
Update POST /Identity/ServiceAccount Create a service account.
Update POST /MachineCatalogs Create a machine catalog.
Update POST /Machines/$search Perform an advanced search for machines.

June 2024

Change Type API Summary
Addition DELETE /Identity/Machines/{machine} Delete a machine identity
Addition DELETE /Identity/ServiceAccount/{serviceAccountUid} Delete an existing service account.
Addition GET /Identity/AzureADTenants/{azureAdTenantId}/AzureADSecurityGroups Query AzureAD security group by user’s input.
Addition GET /Identity/AzureADTenants/{azureAdTenantId}/AzureADSecurityGroups/{groupId} Get Azure AD security group by group id.
Addition GET /Identity/AzureADTenants/{azureAdTenantId}/AzureADSecurityGroups/{groupId}/members Retrieves all the group type of members of a specific group
Addition GET /Identity/Containers Get containers from identity provider.
Addition GET /Identity/Containers/{container} Get a single container (e.g. OU)
Addition GET /Identity/Directories Get list of directories from all identity providers
Addition GET /Identity/Domains Get list of domains from the identity provider
Addition GET /Identity/Domains/{domain} Get a single domain from the identity provider
Addition GET /Identity/Domains/{domain}/AzureADCustomDomain Gets the Azure AD custom domain with the specified domain name.
Addition GET /Identity/Forests Get the list of forests from the identity provider
Addition GET /Identity/Forests/{forest} Get information about a single forest
Addition GET /Identity/Machines Get machine accounts from identity provider
Addition GET /Identity/Machines/{machine} Get a single machine account from identity provider
Addition GET /Identity/ServiceAccount/{serviceAccountUid} Get a specific service account.
Addition GET /Identity/ServiceAccounts Get all service accounts.
Addition GET /Identity/Sites Get list of sites from the identity provider
Addition GET /Identity/Sites/{site} Get information about a single site
Addition GET /Identity/Users Get users from identity provider
Addition GET /Identity/Users/{userOrGroup} Get a single user or group
Addition GET /PvsStreaming/Sites Get the list of PVS sites.
Addition GET /PvsStreaming/Stores/{farmId} Get the list of PVS stores.
Addition GET /PvsStreaming/vDisks Get the list of PVS vDisks.
Addition GET /Sites/{nameOrId}/MisconfigurationReport Get the misconfiguration report.
Addition PATCH /Identity/Machines/{machine} Update a machine identity
Addition PATCH /Identity/ServiceAccount/{serviceAccountUid} Set properties of an existing service account.
Addition PATCH /Identity/Users/{user} Update a user identity
Addition POST /hypervisors/{nameOrId}/allResources/$search Search the resources within a hypervisor.
Addition POST /Identity/Machines Create machine identity
Addition POST /Identity/ServiceAccount Create a service account.
Addition POST /Identity/Users/$validate Validate a user’s credentials
Addition POST /PvsStreaming/$checkDeviceCollectionName Test the existence of a device collection by name.
Addition PUT /Identity/AzureADTenants/{azureAdTenantId}/AzureADSecurityGroups/{groupId}/members/{refGroupId} Add a security group to an assigned security as it’s member
Update GET /Jobs/{id} Get the details of a single job.
Update GET /me Get my details.
Update POST /$checkObjectNameExists/{objectType}/{nameOrPath} Check for the existence of an object.
Update POST /Applications/$search Perform an advanced search for applications.
Update POST /ConfigLog/Operations/$search Perform an advanced search for configuration log entries.
Update POST /hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$search Search the resources within a hypervisor resource pool.
Update POST /MachineCatalogs Create a machine catalog.
Update POST /Machines/$search Perform an advanced search for machines.

April 2024

Change Type API Summary
Addition DELETE /gpo/filters/{filterGuid} Delete an existing filter.
Addition DELETE /gpo/policies/{policyGuid} Delete an existing GPO policy. A policy in the policy set of type SiteTemplates cannot be deleted. The Unfiltered policy in the policy set of type SitePolicies cannot be deleted.
Addition DELETE /gpo/policySets/{policySetGuid} Delete an existing GPO policy set. Only policy sets of type DeliveryGroupPolicies can be deleted. Policies in the policy set are deleted if a policy set is deleted.
Addition DELETE /gpo/settings/{settingGuid} Delete a setting. Settings in the policy set of type SiteTemplates cannot be deleted.
Addition GET /gpo/filterDefinitions Get all filter definitions.
Addition GET /gpo/filters Read filters defined in a policy. A policy in a policy set of type SiteTemplates or CustomTemplates does not have filters.
Addition GET /gpo/filters/{filterGuid} Read a specific filter.
Addition GET /gpo/policies Read all policies defined in a policy set. Policy templates don’t have filters.
Addition GET /gpo/policies/{policyGuid} Read a policy. A policy template doesn’t have filters.
Addition GET /gpo/policySets Get all GPO policy sets in the site.
Addition GET /gpo/policySets/{policySetGuid} Read a GPO policy set.
Addition GET /gpo/settingDefinitions Get setting definitions. If isLean is set to true, only basic session information is returned. EnumType, VdaVersions, VersionDetails, and Explanation are not retrieved. If limit is set to -1 or a number larger than the number of settings available, all entries are retrieved. If limit is set to a positive integer smaller than the number of settings available, the specified number of settings are retrieved.
Addition GET /gpo/settingFullDetail Get full detail of a setting definition.
Addition GET /gpo/settings Read settings defined in a policy.
Addition GET /gpo/settings/{settingGuid} Read a specific setting.
Addition PATCH /gpo/filters/{filterGuid} Update an existing filter.
Addition PATCH /gpo/policies/{policyGuid} Update a policy. Only the policy body is updated.
Addition PATCH /gpo/policySets/{policySetGuid} Update an existing GPO policy set.
Addition PATCH /gpo/settings/{settingGuid} Update a setting. Settings in the policy set of type SiteTemplates cannot be updated.
Addition POST /$checkObjectNameExists/{objectType}/{nameOrPath} Check for the existence of an object.
Addition POST /gpo/comparePolicies Compare policies. The policies can be from different policy sets.
Addition POST /gpo/filters Create a filter in a policy. Filters cannot be created in a policy in a policy set of type SiteTemplates or CustomTemplates.
Addition POST /gpo/filters/$search Perform an advanced search for GPO filters.
Addition POST /gpo/policies Create a new policy. Policies cannot be created in the policy set of type SiteTemplates.
Addition POST /gpo/policies/$copy Copy some policies of a policy set to other policy sets.
Addition POST /gpo/policies/$disable Disable some policies of a policy set.
Addition POST /gpo/policies/$enable Enable some policies of a policy set.
Addition POST /gpo/policies/$move Move some policies of a policy set to another policy set.
Addition POST /gpo/policies/$remove Remove some policies of a policy set.
Addition POST /gpo/policies/$search Perform an advanced search for GPO policies.
Addition POST /gpo/policyPriorities Specify new priority order for all existing policies in a policy set. All the policies in the policy set must be specified, even if the priorities of only some of the policies are changed.
Addition POST /gpo/policySets Create a new GPO policy set. Only a policy set of type DeliveryGroupPolicies can be created.
Addition POST /gpo/policySets/{policySetGuid} Create a new GPO policy set by copying an existing policy set. The policies and settings in each policy are copied to the new policy set. Optionally, the filters in the policies may be copied. Regardless of the type of the source policy set, the resulting policy set is always of type DeliveryGroupPolicies.
Addition POST /gpo/policySets/$search Perform an advanced search for GPO policy sets.
Addition POST /gpo/settings Create a setting in a policy. Settings cannot be created in the policy set of type SiteTemplates.
Addition POST /gpo/settings/$search Perform an advanced search for GPO settings.
Addition POST /gpo/simulation Simulate policy application.
Addition PUT /gpo/policySets/{policySetGuid} Force serialization of policy set. The data of a policy set is serialized into a byte stream before it is sent to VDAs. The serialization is done automatically in the background at 5 minute intervals. A change made to the data in a policy set may not be in the serialized data for up to 5 minutes. This call tells the background thread to serialize the data immediately. No serialization is done if there have been no changes to the policy set data since the last time the data was serialized.
Update DELETE /MachineCatalogs/{nameOrId} Delete a machine catalog.
Update DELETE /MachineCatalogs/{nameOrId}/MachineAccounts/{machine} Remove a machine account from the machine catalog.
Update DELETE /Machines/{nameOrId} Delete a machine from the site.
Update GET /ConfigLog/Operations Get configuration log operations.
Update GET /Jobs/{id} Get the details of a single job.
Update GET /MachineCatalogs/{nameOrId}/MachineAccounts Get all machine accounts associated with a machine catalog.
Update GET /Machines Get all machines in the site.
Update GET /Sites/{nameOrId}/Settings Get the settings for the site.
Update POST /ApplicationGroups/{nameOrId}/Applications Add applications to the application group.
Update POST /Applications/$search Perform an advanced search for applications.
Update POST /DeliveryGroups Create a delivery group.
Update POST /hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$search Search the resources within a hypervisor resource pool.

February 2024

Change Type API Summary
Addition DELETE /enrollments/{id} Delete an enrollment.
Addition GET /enrollments Get the list of all enrollments in the site.
Addition GET /enrollments/{id} Get a single enrollment from the trust.
Addition GET /MachineCatalogs/{nameOrId}/Enrollments Get the list of enrollments in the machine catalog.
Addition PATCH /ConfigLog/Operations/{id} Update a high level log operation.
Addition POST /ConfigLog/Operations/$fetchExistingLabels Fetch existing high level log operation labels.
Addition POST /enrollments Create an enrollment token.
Addition POST /MachineCatalogs/{nameOrId}/$importProvisionedVirtualMachines Import existing provisioned virtual machines.
Addition PUT /enrollments/{id} Revoke an enrollment.
Update GET /ConfigLog/Operations/{id} Get a high level log operation.
Update GET /Jobs/{id} Get the details of a single job.
Update GET /Sessions/{id} Get details of a single session.
Update POST /ApplicationGroups/{nameOrId}/Applications Add applications to the application group.

November 2023

Change Type API Summary
Addition POST /ApplicationGroups/$search Perform an advanced search for application groups.
Addition POST /MachineCatalogs/{nameOrId}/$repairMachineAccounts Repair all machine accounts in a machine catalog.
Update GET /Jobs/{id} Get the details of a single job.
Update GET /Machines/{nameOrId}/Desktop Get the desktop associated with the machine, if any.
Update POST /Applications/$search Perform an advanced search for applications.

September 2023

Change Type API Summary
Addition GET /Hypervisors/{nameOrId}/OrphanedResources Run detect on a hypervisor and retrieve orphaned resources.
Update GET /ConfigLog/Operations Get configuration log operations.
Update GET /Jobs/{id} Get the details of a single job.
Update POST /Tags Create a tag.

August 2023

Change Type API Summary
Addition POST /Machines/{nameOrId}/$ResetProvVMDisk Resets the OS disk of persistent VMs to the current master image.
Resources
Citrix DaaS REST APIs OpenAPI Specification
Copy Download
Release notes