Skip to main content

XClarity Orchestrator REST APIs

Lenovo XClarity Orchestrator provides a set of easy-to-use APIs that can be used to access XClarity Orchestrator data and services from applications running outside of the XClarity Orchestrator framework. This documentation includes the methods and attributes that apply to the current Lenovo XClarity Orchestrator release and later.

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

The following documentation includes new methods and parameters that apply to the XClarity Orchestrator Version 2.1 and later. If you are using an earlier version of XClarity Orchestrator, 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.

  • Summary of changes in the REST API
    Review this information to learn about new REST API enhancements that are included in each Lenovo XClarity Orchestrator version.
  • Using this REST API
    Review this information to learn about how to use the Lenovo XClarity Orchestrator REST API, including authentication requirements, response codes and error handling, and filtering and sorting.
  • Orchestrator server
    The following REST APIs are available for working with the Lenovo XClarity Orchestrator.
  • Security
    The following REST APIs are available for managing security.
  • Authentication and authorization
    The following REST APIs are available for managing authentication and access control.
  • Resources
    The following REST APIs are available for working with resource managers and their managed devices and infrastructure resources.
  • Jobs
    The following REST APIs are available for managing jobs.
  • Resource management
    The following REST APIs are available for managing resources, such as power-on operations, remote control, and offline management.
  • Analytics
    The following REST APIs are available for analyzing data metrics.