Lenovo XClarity Administrator REST APIs

Lenovo XClarity Administrator provides a set of easy-to-use APIs that can be used to access XClarity Administrator data and services from applications running outside of the XClarity Administrator framework.

The REST APIs allow for easy integration of XClarity Administrator capabilities into other software, whether the software is running on the same system as the XClarity Administrator server, or on a remote system within the same network. These APIs are based on the REST architecture and are accessed via the HTTPS protocol.

Attention

The content type that you specify in the HTTP header must match the format of data that you specify in the request body. If there is a mismatch, XClarity Administrator returns an error code because it cannot parse the data. For example, when sending JSON format, if you specify Content-Type:application/x-www-form-urlencoded, you will receive an error code. The default content type for all requests is application/json; charset=UTF-8.

The following documentation includes new methods and parameters that apply to the XClarity Administrator Version 4.2 and later. If you are using an earlier version of XClarity Administrator, you can use the REST API Reference PDF for a list of methods and parameters that apply to that specific release. To find PDFs for the release that you need, see PDF files.

Give documentation feedback