What’s new in the XClarity One REST APIs for 26c.1 and 26p.1

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).
    • Collections Read. Allows scripts to retrieve collection information.
    • Collections Management. Allows scripts to create, modify, and delete collections.
    • Service Tickets Read. Allows scripts to retrieve service-ticket information.
    • Service Tickets Management. Allows scripts to create service tickets and update service-ticket status.
    • Devices Life Cycle Management. Allows scripts to retrieve information about, create, assign, unassign, deploy, and delete device templates.
    • Firmware Catalog Management. Allows scripts to retrieve information about firmware updates in the respiratory, download and import firmware metadata and firmware packages, import firmware repository packs, and delete firmware update payloads and packages.
    • Data Forwarders Read. Allows scripts to retrieve data-forwarder information.
    • Data Forwarders Management. Allows scripts to add, modify, and enable or disable data forwarders.
  • You can use the common returnAttributes query parameter to return only the specified attributes in the response body (see Paginating, filtering, including data, and excluding data in REST API responses).
  • XClarity One uses secret entities to encrypt sensitive data, such as password. REST APIs have been updated to change password strings into objects that contain the secret entity ID for the encrypted password, the secret entity type, and the encrypted password. For more information about using secret entities in your scripts, see Using sensitive data in custom scripts.

• Device groups

  • POST apis/v1/boarding/management. Changed servers.config.password and servers.config.newPassword request attributes to an object that contains information about the encrypted credentials (see Using sensitive data in custom scripts).
  • (New) GET /api/v1/groups-management/resourceGroups. Return a list of all resource groups.
  • (New) GET /api/v1/groups-management/resourceGroups/:id. Return information about a specific resource group.
  • (New) POST /api/v1/groups-management/resourceGroups/:id. Create a resource group.
  • (New) PATCH /api/v1/groups-management/resourceGroups/:id. Modify a specific resource group.
  • (New) DELETE /api/v1/groups-management/resourceGroups/:id. Delete a specific resource group.

• Device configuration

  • (New) GET /api/v1/templates-management/templates. Return a list of all device templates.
  • (New) POST /api/v1/templates-management/templates. Create a device template.
  • (New) GET /api/v1/templates-management/templates/:id. Return information about a specific device template.
  • (New) DELETE /api/v1/templates-management/templates/:id. Delete a specific device template.
  • (New) POST /apis/v1/templates-management/management. Assign or unassign a device template to specified resources or to deploy assigned templates to specified resources.
  • (New) GET /apis/v1/catalogs-management/firmwarePackages. Return information about all firmware packages.
  • (New) POST /apis/v1/catalogs-management/firmwarePackages. Download a specific firmware payload from the Lenovo Support website or import a specific firmware package or repository pack form the local system.
  • (New) DELETE /apis/v1/catalogs-management/firmwarePackages/:id. Delete a specific firmware payload.

• Data forwarders

  • (New) GET /apis/v1/outbound/forwarders.. Return a list of all data forwarders
  • (New) POST /apis/v1/outbound/forwarders. Create a data forwarder.
  • (New) GET /apis/v1/outbound/forwarders/:id. Return information about a specific data forwarder.
  • (New) PUT /apis/v1/outbound/forwarders. Modify a specific data forwarder.
  • (New) PATCH /apis/v1/outbound/forwarders. Enable or disable a specific data forwarder.
  • (New) DELETE /apis/v1/outbound/forwarders. Delete a specific data forwarder.
  • (New) POST /apis/v1/outbound/forwarderDestinations. Create a data-forwarders destination.
  • (New) DELETE /apis/v1/outbound/forwarderDestinations/:id. Delete a specific data-forwarders destination.
  • (New) POST /apis/v1/monitoring/filters. Create an event filter.
  • (New) DELETE /apis/v1/monitoring/filters/:id. Delete a specific event filter.

• Storage entities

  • (New) POST /apis/v1/storage/secretEntities. Create a secret entity that is used to send sensitive data (such as passwords) to the XClarity One portal in a way that it cannot be read by the portal. This entity is never stored in the portal.
  • (New) PATCH /apis/v1/storage/secretEntities/:id. Add encryption details (encryption key, IV, and authentication tag) and encrypted payload to a specific secret entity.

• Service and support

  • (New) GET /api/v1/service/serviceTickets. Return a list of all service tickets.
  • (New) PUT /apis/v1/service/serviceTickets. Update the status of active service tickets by synchronizing data with the Lenovo Support Center.
  • (New) POST /api/v1/service/serviceTickets. Open a Call Home service ticket in the Lenovo Support Center or test the connection with the Lenovo Support Center.
  • (New) GET /api/v1/service/serviceTickets/:id. Return information about a specific service ticket.