REST APIs

February 23, 2024

Contributed by:

K C K

With the Citrix Endpoint Management REST API, you can:

Call services that display in the Citrix Endpoint Management console
Call REST services by using any REST client

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

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

There are APIs available 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:

From the Citrix Cloud menu, select Identity and Access Management.
Select API Access > Secure Clients.
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 the REST API services

You can call the 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 the 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-->

Citrix Endpoint Management REST API

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

REST APIs

February 23, 2024

Contributed by:

K C K

February 23, 2024

Contributed by:

K C K

REST APIs

Permissions required to access the REST API

To invoke the REST API services

Log in

Related information

In this article