Summary of changes in the REST API for v3.4

Lenovo XClarity Administrator v3.4 supports enhancements to the Open REST API.

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

Management-server update resources
- GET /managementServer/updates. Added the size.upperLimitSpace response parameter to return the maximum amount of space that can be allocated to the firmware-updates repository.
- (New) GET /registration. Returns information about the XClarity Administrator registration status.
- (New) POST /registration. Sends a registration request to the Lenovo eSupport website and retrieve the registration token.
- (New) PUT /registration. Imports the registration token in the management server.
- (New) GET /registration/countries. Returns a list of country and region codes that can be used during the registration process.
- (New) GET /registration/details. Returns information about the registration settings.
Discovery and management resources
- POST /manageRequest. Added the Lenovo Thinksystem DB series value to the subtype response attribute.
Inventory resources
- GET /nodes/{uuid_list}. Added the lenovo-AMI-controller value to the mgmtProcType query attribute.
- PUT /nodes/{uuid}. Added the clearSelLog query parameter to clear the SEL log for the device.
- (New) POST /nodes/ssdRemainingLifeStatistics. Returns remaining life statistics for SSDs in managed servers.
Firmware update resources
- GET /updateRepositories/firmware. Added the size.upperLimitSpace response parameter to return the maximum amount of space that can be allocated to the firmware-updates repository.
- (New) POST /compliancePolicies. Creates, copies, or imports a firmware-compliance policy
- (New) PUT /compliancePolicies. Modifies or exports a firmware-update compliance policy.
Operating-system deployment resources
- GET /osdeployment/globalSettings. Added the globalSetting.licenseKeys.win2022r1 response parameter to return information about volume-license keys for Microsoft Windows 2022.
- PUT /osdeployment/globalSettings. Added the globalSetting.licenseKeys.win2022r1 request parameter to configure the volume-license keys for Microsoft Windows 2022
Metrics resources
- GET /metrics_service/metrics/servers. Added the interval query parameter to return data in the specified intervals. Added the top query parameter to return the specified number of highest metric values for each managed server. Added the uuids parameter to return metrics data for one or more specific servers.
- (New) POST /metrics_service/metrics/servers. Returns a specific number of top metric values among all or specific managed servers.
Service and support resources
- (New) GET /bulletinService. Returns a list of all current service bulletins.
- (New) PUT /bulletinService. Modifies service bulletin options.

Give documentation feedback