Skip to main content

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.1 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.

  • Summary of changes in the REST API
    Review this information to learn about new REST API enhancements that are included in each Lenovo XClarity Administrator version.
  • Using this REST API
    Review this information to learn about how to use the Lenovo XClarity Administrator REST API, including authentication requirements, response codes, and error handling.
  • Virtual-appliance management
    The following resources are available for managing the Lenovo XClarity Administrator virtual appliance.
  • Management-server update
    The following resources are available for performing management-server update functions.
  • Discovery and management
    The following resources are available for performing discovery, manage, and unmanage functions.
  • Inventory
    The following resources are available for performing inventory functions.
  • Resource-group
    The following resources are available for managing resource groups.
  • Backup and restore
    The following resources are available for backing up and restoring RackSwitch and Flex System switch configurations and Lenovo XClarity Administrator data, settings, and devices.
  • Server configuration
    The following resources are available for performing server configuration (Configuration Patterns) functions.
  • Firmware update
    The following resources are available for performing firmware updates functions.
  • Operating-system deployment
    The following resources are available for performing operating-system deployment functions.
  • Events and alerts
    The following resources are available for performing monitoring and event functions, such as getting events, getting event status, and setting up event monitors.
  • Jobs
    The following resources are available for performing task and job management functions.
  • Remote control
    The following resources are available for remotely accessing servers. .
  • Security
    The following resources are available for performing security functions.
  • Service and support
    The following resources are available for performing service and support functions.
  • Metrics
    The following resources are available for collecting and forwarding metrics for the devices that are managed by Lenovo XClarity Administrator.