Skip to main content

Lenovo XClarity One REST APIs

Lenovo XClarity One REST APIs allow for easy integration of XClarity One data and services into other software running on a remote system within the same network. These APIs are based on the REST architecture and are accessed using the HTTPS protocol.

This online documentation contains the latest REST API reference information and applies to the most current XClarity One release.

ATTENTION: The REST APIs are currently under development. Take care when creating custom scripts as some REST APIs might change in future releases, and those changes might require you to update your scripts.

You can test the REST APIs directly in this interface after creating a connection to your XClarity One portal. Follow these steps to create a connection and invoke a REST API. For more information, see REST API authentication and authorization.

  1. Create an API key from the XClarity One portal web interface by clicking REST API key on the context menu from the Settings view, and then click the Add icon. A unique client ID and client secret is created for the API key.

    Attention: Immediately after creating a new API key, copy and record the client ID and client secret in a safe location. The secret is shown as plain text only when the API key is first created. After you close the dialog, only the last three characters of the secret is viewable for security purposes. If you lose the client secret, you can regenerate a new secret for the API client by clicking the Regenerate secret icon.

  2. Generate generate a JWT access token by making a POST request to the access token request URL, which you can find on the API key details page. You can do this from Create an Access Toke in this online REST API reference.

    Copy the token that is returned in the response panel.

    Note: The access token expires after 5 minutes.

  3. Find the REST API that you want to invoke. Then, paste the access token in the Bearer Token field in Request panel.