Summary of changes in the REST API for v2.3.0

This documentation includes new methods and attributes 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 attributes 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.

• Monitoring and event resources

  The following REST APIs will be deprecated in a future release:

  • GET /inventory/activeAlerts. Use GET /events/activeAlerts instead.
  • GET /inventory/activeAlerts/{uuid}. Use GET /events/activeAlerts/{uuid} instead.

• Firmware update resources

  • (New) POST /files/compliancePolicies?action=import. Imports a zip file containing firmware-compliance policies into XClarity Administrator.
  • (New) POST /files/updateRepositories/firmware/import. ​Imports a firmware update or UpdateXPress System Pack (UXSP) to the updates repository.
  • (New) POST /files/updateRepositories/firmware/import/validation. Checks the file size before importing firmware updates and UXSP in to the repository to ensure that there is enough file space to store them and reserve part of file space for the import operation.
  • (New) GET /updateRepositories/firmware. Retrieves information about firmware in the firmware-updates repository or exports firmware-update files to the local system.
  • (New) PUT /updateRepositories/firmware. Modifies information about firmware updates in the updates repository.
  • (New) GET /updateRepositories/firmware/status. Retrieves the status for an action against the firmware updates repository.
  • (New) GET /updateRepositories/firmware/uxsps. Retrieves information about all UpdateXpress System Packs (UXSPs) in the repository (for firmware updates and OS device drivers.
  • (New) PUT /updateRepositories/firmware/uxsps. Modifies information about UpdateXpress System Packs (UXSPs) in the updates repository.
  • (New) DELETE /updateRepositories/firmware/uxsps/{id_list}. Deletes one or more UpdateXpress System Packs (UXSPs) and firmware updates from the repository.

• Security resources

  The following REST API is deprecated in this release:

  • DELETE /certificateSigningRequest

• Service and support resources

  • PUT /service/callHomeGeneral. Removed all existing request attributes. Added the primaryContacts and secondaryContacts request attribute to specify the support contacts.