GET /registration

Use this method to return information about the Lenovo XClarity Administrator registration status.

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


Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/registration

Query parameters


Request body


Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
company String Company name
country String Country code for the location of the management server

To obtain the country code, use GET /registration/countries.

deviceCount Integer Number of managed devices
status Integer Indicates status information about whether the system has free license registered
  • 0. Not registered
  • 1. Registered
token String Registration token

If a token is not installed, this value is null.

The following example is returned if the request is successful.
   "company": "Some Company",
   "country": "us",
   "deviceCount": 250,
   "status": 1,
   "token": "0DF4-0110-E231"