GET /registration/details

Use this method to return information about the registration settings.

Note: This REST API requires Lenovo XClarity Administrator v3.4.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/registration/details

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
compliant Integer Indicates whether XClarity Administrator is compliant with installed licenses. This can be one of the following values.
  • 0. XClarity Administrator is not compliant.
  • 1. XClarity Administrator is compliant.
  • 2. XClarity Administrator is registered.
freeOfWarning Integer Indicates whether XClarity Administrator is registered and license warnings are suppressed. This can be one of the following values.
  • 0. XClarity Administrator is not registered. License warnings are displayed.
  • 1. XClarity Administrator is registered. Licenses warnings are suppressed.
The following example is returned if the request is successful.
{
   "compliant": 2,
   "freeOfWarning": 1
}