Citrix Cloud

SDKs and APIs

Citrix Cloud provides several APIs that you can use to retrieve information and automate complex and repetitive tasks, including:

  • Silently install Citrix Cloud Connector
  • Create and consume reports for managing cloud licenses
  • Determine a customer’s entitlement status
  • Send notifications to Citrix Cloud administrators
  • Retrieve System Log events
  • Retrieve details about your resource locations to use with other APIs

Several Citrix Cloud services also provide SDKs and APIs that allow you to retrieve information, query data, and perform administrative tasks.

Secure clients

To use Citrix Cloud APIs, you need to create a secure client that accesses Citrix Cloud on your behalf. To create a secure client, you’ll need to supply the customer ID of your Citrix Cloud account. Your customer ID is located in the following places in the management console:

  • The top-right corner of the console, underneath your user name.
  • Your Account Settings page.

    Customer menu with Account Settings highlighted

  • The API Access page.

    API Access page with customer ID highlighted

Inherited permissions

Secure clients are tied to a single administrator and a single customer ID in Citrix Cloud. This means your secure clients inherit the same level of permissions that you have under a specific customer ID. So, if you have full access permissions, your secure clients also have full access permissions. If your permissions level is reduced at a later time, the secure clients that you’ve already created automatically inherit your reduced permissions.

If you’re an administrator for multiple customers, you must create separate secure clients for each customer ID. Secure clients that you create under one customer ID are not visible to other administrators or when you’re signed in to a different customer.

For instructions to create secure clients, see Get started with Citrix Cloud APIs in the Citrix Developer documentation.

Cloud licensing APIs

Enterprise customers can use cloud licensing APIs to perform management tasks like exporting usage data and releasing assigned licenses. Citrix partners can use these APIs to retrieve summary and historical data for on-premises Citrix Virtual Apps and Desktops and Citrix DaaS.

For more information, see APIs to manage Citrix cloud licensing in the Citrix Developer documentation.

SystemLog API

The SystemLog API allows you to retrieve events that occurred in your Citrix Cloud account for periods of time that you specify. For more information about using this API, see Citrix Cloud - SystemLog in the Citrix Developer documentation.

Resource Locations API

The Resource Locations API allows you to retrieve information about your resource locations for use with other applications and scripts. For example, let’s say that you want to silently install the Citrix Cloud Connector in one of several resource locations in your Citrix Cloud account. You can use this API to retrieve the resource location ID and pass it to your install script.

For more information about using this API, see Citrix Cloud - Resource Location in the Citrix Developer documentation.

Service Entitlement API

The Service Entitlement API retrieves the services a customer is entitled to use, the days remaining on each entitlement, and the quantity of entitlements that the customer purchased. For more information about using this API, see Citrix Cloud - Service Entitlement in the Citrix Developer documentation.

Notifications API

The Notifications API allows you to send messages to other Citrix Cloud administrators. Recipients receive your messages through the Notifications page in the management console.

SDKs and APIs for other services

For more information about the SDKs and APIs that are available for other Citrix Cloud services, see the following articles:

  • Digital workspaces: Includes SDKs and APIs for workspace services like Citrix DaaS, Content Collaboration, and Citrix Workspace.
  • App delivery and security: Includes SDKs and APIs for networking and app delivery services like Application Delivery Management, Intelligent Traffic Management, and SD-WAN Orchestrator.

More information

To learn more about how Citrix Cloud APIs and secure clients can help you perform complex operations like migrating to the cloud and configuring authentication with push tokens, see the following Tech Zone articles:

SDKs and APIs