Skip to main content

Summary of changes in the REST API for v1.2

Lenovo XClarity Orchestrator v1.2 supports enhancements to the Open REST API.

This documentation includes new methods and parameters that apply to the current XClarity Orchestrator release and later. If you are using an earlier release 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.

The following methods were added or updated in this release.

  • General
    • All GET requests return 401 when the user session is expired because the web inactivity session timeout expired or the mandatory session expiration time was exceeded. You must log in again to view data. For information about session timeouts, see Configuring user security settings.
    • All POST, PUT, PATCH, and DELETE requests return 406 when the user session is expired because the Web inactivity session for full operations timeout expired or the mandatory session expiration time was exceeded. You must log in again to modify data. For information about session timeouts, see Configuring user security settings.
  • Resources
    • GET /api/v1/connector/managers. Added the healthStateKey attribute to return the health state key. Removed the following response attributes: build, ipAddress, issues, ipAddress, networkSettings, userName, uuid, and version. For a complete list of resource manager attributes, use GET /api/v1/connector/managers/{id}.
    • POST /api/v1/connector/managers. The request body is refactored to support multiple resource manager types.

      A job is created to complete this request. The response header returns the URI for the job in the Location field. A successful response code indicates that the job was successfully transmitted and accepted by the orchestrator. If a job was not successfully started, refer to the response code and response body for details.

    • GET /api/v1/connector/managers/{id}. Added the authenticationKey attribute to return the authentication key. Added the connection attribute to return information about connection settings. Added the details attribute to return information about the resource manager properties. Added the healthStateKey attribute to return the health state key. Added the lastInventorySyncTimestamp attribute to return the timestamp when XClarity Orchestrator last refreshed the inventory for the resource manager. Added the lastISyncTimestamp attribute to return the timestamp when XClarity Orchestrator last refreshed the information about the resource manager. Added the updateMetadata attribute to return information about the update history for the resource manager. Removed the following response attributes: build, certificateID, networkSettings, passwordKey, userName, uuid, and version.
    • (New) PATCH /api/v1/connector/managers/{id}. Modifies authentication and connection settings for a resource manager.
    • (New) DELETE /api/v1/connector/managers/{id}. Disconnects (removes) a specific resource manager.
    • The following REST API is deprecated in this release.