In December 2013, we released App Orchestration 2.0 as part of Cloud Provider Pack 2. I encourage all of our CSP partners to check it out, download, and start using AO to orchestrate and automate your cloud deployments of XenDesktop and XenApp. It has a huge number of new features and functionality that are going to make it much easier to scale and manage your business.
Of course, our innovative and imaginative partners will certainly find new ways that they’d like to use App Orchestration, integrate it into existing systems, or extend the functionality in ways that Citrix has not yet envisioned. For that, we have created a complete publicly available API that exposes all of the functionality available in App Orchestration.

Of course, an API is only as good as its documentation. For that reason we have, from day one, built complete documentation for the API into the product itself, including documents explaining high-level concepts and the use of the API, all the way down to documentation on individual methods, properties, and valid values for every property within the API. Every API and data structure includes examples to help you get started right away.

There are two ways to access the API documentation:

  1. Within a running App Orchestration system, point your browser at this URL on the server:

    https://[server]/cam/api/help

    The advantage of this approach is that you always have access to correct, up-to-date documentation for the version of App Orchestration you have installed. Even if there are API changes across versions or hot fixes, you can be assured that you always have the correct documentation.

  2. Download the offline version of the API help from this blog. I will also be working to get this available as a download from the Cloud Provider Pack download page. In the meantime it’s attached to this blog post. Just unzip to a folder on your computer, then open the “index.html” file in your browser.
    The advantage of this approach is that you can read through the API even before you install App Orchestration.

I would love to hear feedback on the APIs and API documentation we provide. Let us know about your experiences in the comments!

Happy coding!

AppOrchestrationApiDoc.zip