What’s new in the XClarity One REST APIs for 26c.2 and 26p.2
XClarity One 26c.2 and 26p.2 support the following enhancements to the REST API.
In addition to Microsoft Windows, you can install the LXC1PSToolkit on Linux and MacOS operating system. You can also install the toolkit in a custom directory
The following REST APIs were added or updated in this release.
General
You can assign the following new privileges to API keys (see REST API authentication and authorization).
- Device Metrics Read. Allows scripts to retrieve metric data for one or more devices or groups.
- Service Data Collection. Allows scripts to collection service data for the portal or save the latest service-data archive to the local system.
Portal management
(New) GET /api/v1/maintenance/serviceData. Save (export) the latest service-data archive to the local system and then delete the archive from the repository.
(New) POST /api/v1/maintenance/serviceData. Collect portal service data.
Discovery and management
GET /apis/v1/boarding/devices. Added the storage value to the type response attribute to return information about storage devices
POST /apis/v1/boarding/discovery. Added the credentials request parameter to specify local credentials when managing storage devices. Added the deviceCategory request parameter to specify the device category when managing storage devices. Added the manage request parameter to indicate whether to manage storage devices that were discovered as part of this discovery process.
POST /apis/v1/boarding/management. Added the storage request parameter to manage storage devices using local credentials.
Devices
GET /apis/v1/devices-management/devices/:id. Added the configuration.currentDeviceSettings response attribute to return information about the current device-settings that were fetched for this device. Added the deviceSettings.details.raidSettings response attribute to return information about the value of each RAID setting.
Device configuration
POST /api/v1/templates-management/management. Added the templateComponents request attribute to list the template components to be applied.
Alerts, events, and jobs
GET /apis/v1/monitoring/events. Replace fans with cooling for the available values in the category response attribute.
GET /apis/v1/monitoring/events/:id. Replace fans with cooling for the available values in the category response attribute.
GET /apis/v1/monitoring/alerts. Replace fans with cooling for the available values in the category response attribute.
GET /apis/v1/monitoring/alerts/:id. Replace fans with cooling for the available values in the category response attribute.
Analytics, metrics, and statistics
(New) GET apis/v1/data/resourceMetrics. Return metric data for one or more devices and device groups.
GET /apis/v1/data/devicesStatistics [INTERNAL]. Added the templateCompliance response attribute to return device statistics for each template-compliance state.
Service and support
GET /apis/v1/service/serviceTickets. Removed componentName, response attribute. Moved machineType, model, name, productName, and serialNumber response attributes under the resources object. Added the createdBy response attributes to return the username that created the service ticket or XClarity One if automatically created by Call Home.
GET /apis/v1/service/serviceTickets/:id. Removed componentName, creationMode, deviceType, event, fruData, groups, manager, originalState, , severityPriority, source, and sourceName response attributes. Moved machineType, model, name, productName, and serialNumber response attributes under the resources object. Added the createdBy response attributes to return the username that created the service ticket or XClarity One if automatically created by Call Home.