Developing for Citrix Hypervisor

Explore SDKs and Tools

SDK Overview

Citrix Hypervisor can be programatically managed using the XenAPI or XAPI. XAPI is an open source sub-project of the Xen Project. XAPI is an XML-RPC based API, providing programmatic access to the extensive set of Citrix Hypervisor management features. The Citrix Hypervisor API can be called from a remote system as well as local to the Citrix Hypervisor host. Remote calls are generally made securely over HTTPS, using port 443.

There are five SDKs available, one for each of C, C#, Java, PowerShell, and Python. Prior to Citrix Hypervisor 6.1, these SDKs were available under a LGPL/GPL license model, but the current SDKs use a BSD license. All SDKs are backwards compatible to Citrix Hypervisor 4.0, but it is always preferable to use the most recent SDK. To ensure a graceful fallback, client programs are expected to call host.software_version["product_version"] when appropriate.

XenServer API References

Download SDK Components

Citrix Hypervisor Plugin Development

The Citrix Hypervisor Transfer VM is used to import and export virtual disk images.

Extending XenCenter

In addition to APIs for Citrix Hypervisor, the XenCenter code is also available and XenCenter is extensible via the XenCenter Plugin model.

Code Examples

Further Resources

Citrix Hypervisor SDK Forum (Citrix.com)

Development Tips

Additional Citrix Developer Learning Resources

SDK Documentation Feedback

We are working to improve our SDK deliverables to make them easier to use.  Click the link below to take a quick survey and share your feedback with our team.

Open the survey

Create your Citrix Developer account today
An account gives you access to all of the benefits of the Citrix Developer community.

You built a great solution integrating with Citrix APIs, now continue the next step of your journey with Citrix Ready.