Skip to main content

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​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/registration

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
companyStringCompany name
countryStringCountry code for the location of the management server

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

deviceCountIntegerNumber of managed devices
statusIntegerIndicates status information about whether the system has free license registered
  • 0. Not registered
  • 1. Registered
tokenStringRegistration 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"
}