Citrix Endpoint Management

REST APIs

With the Endpoint Management REST API, you can:

  • Call services that are exposed through the Endpoint Management console
  • Call REST services by using any REST client

The API does not require you to sign on to the Endpoint Management console to call the services.

For the complete current set of available APIs, download the Public API for REST Services PDF.

For Endpoint Management environments that are workspace enabled, we have APIs to manage your mobile and desktop endpoint devices and configure settings for your Workspace apps. Go to https://developer.cloud.com/citrixworkspace and navigate to Citrix Endpoint Management > Mobile Application Integration.

Permissions required to access the REST API

Access to the REST API requires one of the following permissions:

  • Citrix Cloud administrator
  • Public API access permission set as part of role-based access configuration. For information, see Configuring roles with RBAC.
  • Super user permission

To access the REST API using your Citrix Cloud account, generate the API keys:

  1. From the Citrix Cloud menu, select Identity and Access Management.
  2. Select API Access > Secure Clients.
  3. Type a name for your secure client and click Create Client.

Citrix Cloud then creates the secure client ID and client secret. Download a copy of this information and save it securely offline for your reference. Citrix Cloud doesn’t store the unique identifiers after you close the dialog box.

To invoke REST API services

You can invoke REST API services by using the REST client or cURL commands. The following examples use the Advanced REST client for Chrome.

Note:

In the following examples, change the host name and port number to match your environment.

Log in

The example shown here covers logging in using a token retrieved through Citrix Cloud API.

URL: https://<host-name>:<port-number>/xenmobile/api/v1/authentication/login/cloud

Method type: POST

Content type: application/json

Request sample:

{
 "bearerToken": "eyJ0eOiJSUzJiibGcI1AiONiJ9.eyJkIjoMDExN1c2VIXiMzNDc1OTk4...qf0iQ"
}
<!--NeedCopy-->

You must retrieve the bearer token using the Citrix Cloud API https://trust.citrixworkspacesapi.net/Help/Api/POST-customer-tokens-clients. For information, see the Developer documentation.

Response sample:

{
 "auth_token": "q483409eu82mkfrcdiv90iv0gc:q483409eu82mkfrcdiv90iv0gc"
}
<!--NeedCopy-->
REST APIs