XenMobile Server Current Release

REST APIs

November 20, 2023

Contributed by:

K C

Note:

This article covers the REST APIs for the XenMobile Server. For the REST APIs for Endpoint Management, see REST APIs.

With the XenMobile REST API, you can call services that are exposed through the XenMobile console. You can call REST services by using any REST client. The API does not require you to sign on to the XenMobile console to call the services.

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

Permissions required to access the REST API

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

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

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

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

Request: { "login":"administrator", "password":"password" }

Method type: POST

Content type: application/json

Image of login payload and request and response headers

XenMobile 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

November 20, 2023

Contributed by:

K C

November 20, 2023

Contributed by:

K C

REST APIs

Permissions required to access the REST API

To invoke REST API services

Log in

Related information

In this article