Skip to main content

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.

  • REST API authorization and authentication
    When programming with the Lenovo XClarity Administrator REST APIs, you must authenticate using a user ID and password. The user ID must have the correct authorization to perform the intended task.
  • REST API response codes
    The Lenovo XClarity Administrator REST APIs use the HTTP protocol for sending and retrieving data. Client code using the REST APIs makes an HTTP request to the Lenovo XClarity Administrator server and processes the HTTP response accordingly. Included with the HTTP response data is the HTTP response code. The response code provides some indication as to the success of the HTTP request and can provide information on how to handle the included response data.
  • Status messages
    The status message attributes identify the success or failure of an REST API operation.