Product Documentation

REST APIs

Sep 06, 2017

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 XenMobile 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 on setting role-based access, 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.

Login

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

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

Method type: POST

Content type: application/json

localized image