GET /licenseCompliance

Use this method to retrieve information about whether Lenovo XClarity Administrator is license compliant.

Note: This API requires Lenovo XClarity Administrator v2.7.0 or later.


Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/licenseCompliance

Query parameters


Request body


Response codes

Code Description
200 OK
400 Bad request
403 Forbidden
409 Conflict
500 Internal server error

Response body

Parameters Type Description
response Array of objects Information about compliance for each license
  compliant Integer Indicates whether XClarity Administrator is compliant with the license. This can be one of the following values.
  • 0. XClarity Administrator is not compliant

  • 1. XClarity Administrator is compliant.

result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

   "response": [{
      "compliant": 1
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      "explanation": ""