About Citrix Virtual Apps and Desktops REST APIs
Use the Citrix Virtual Apps and Desktops REST APIs to automate the administration of resources within a Citrix Virtual Apps and Desktops site. Citrix Virtual Apps and Desktops offers you virtualization solutions that give you control of virtual machines, applications, licensing, and security while providing anywhere access for any device.
Use these APIs to automate the following tasks:
- Build and manage App-V servers and packages that are used to make applications available to end users without direct installation.
- List the site IDs, site permissions, app icons, and StoreFront servers assigned to a customer.
- Create and manage hypervisors, catalogs, apps, and delivery groups.
- Make asynchronous API calls.
- Manage sessions and configuration operations.
- Get information about zones.
Currently, the following API categories are supported:
- About API: Provides basic information about a customer site.
- Admin APIs: Manages delegated administrators and their scoped permissions within a customer site.
- Application Folders APIs: Manages application folders and their associated resources within a customer site.
- Application Groups APIs: Manages application groups and their associated resources within a customer site.
- Applications APIs: Manages applications and their associated resources within a customer site.
- App-V Isolation Groups APIs: Manages App-V isolation groups within a customer site.
- App-V Packages APIs: Manages App-V packages within a customer site.
- App-V Servers APIs: Manages App-V servers within a customer site.
- Batch APIs: Makes multiple API calls in a batch with a customer site.
- Config Logging APIs: Retrieves configuration logging records within a customer site.
- Delivery Groups APIs: Manages delivery groups and their associated resources within a customer site.
- Health Check API: Runs health check on a customer site.
- Hypervisors APIs: Manages hypervisor, resource pools, and resources within a customer site.
- Icons APIs: Manages icon resources within a customer site.
- Jobs APIs: Manages and gets the status or results of jobs (asynchronously launched tasks) with a customer site.
- Machine Catalogs APIs: Manages catalogs and their associated resources within a customer site.
- Machines APIs: Manages machines and their associated resources within a customer site.
- Me APIs: Manages basic information about the current login admin. These APIs do not require a customer or site ID.
- Sessions APIs: Manages sessions and their associated resources within a customer site.
- Sites APIs: Gets information and manages configurations of a specific customer site.
- StoreFront Servers APIs: Manages StoreFront servers and their associated resources within a customer site.
- Tags APIs: Manages tags and their associated resources within a customer site.
- Time Zones API: Gets time zones supported by a customer site.
- Zones APIs: Manages zones and their associated resources within a customer site.
To get started with these tasks using REST APIs, go through the learning journey section. You can also follow the instructions, sample codes, and examples in the how-to articles.
Who can use this API service
A Citrix Virtual Apps and Desktops customer can use these APIs to develop automated programs and manage site resources.
Getting started
Read the Learning journey for Citrix Virtual Apps and Desktops APIs section.