Developer Blog - API Updates in Preservica 8.3

For a summary of all our APIs, you can use the documentation index page.

Preservica 8.3 is a Cloud-only release and is not a Long Term Support (LTS) release. These API changes will be made available to non-cloud environments with our next LTS release, currently planned to be in early 2026.

Admin API

This API allows you to configure your Preservica system.

Changes since 8.2

• We've amended the existing GET /users endpoint to add optional parameters for filtering, paginating, and expanding the results.

Entity API

The Entity API is the main way we expose information about entities stored in your Preservica system.

Changes since 8.2

• We've added a new POST /actions/metadata-csv-edits endpoint, which allows for bulk metadata addition via a CSV file.
• We've amended the existing GET /information-objects/{ref} endpoint to support the expand parameter receiving a value of structure.

Entitlement API

The Entitlement API exposes information about editions and features from the Entitlement Management System.

Changes since 8.2

• We've added a series of endpoints for managing feature module addons, which allow feature modules to be enabled for customers using editions of Preservica on which they would normally not be available. These endpoints require admin access and will not be relevant to most users, but could be of use to some Enterprise-on-Premise (EoP) customers.

Process API

The Process API is for starting processes, and retrieving and updating configuration for processes.

Changes since 8.2

• We've added a new GET /catalog/configs endpoint, which returns a list of catalog process configurations, optionally filtering by process type.
• We've added a new DELETE /catalog/configs/{id} endpoint, with which you can delete a catalog configuration.

Process Monitor API

The Process Montoring API is the main way we expose monitoring information about ongoing processes, messages associated with them, and a day-by-day history of long running processes.

Changes since 8.2

• We've added a new POST /messages/prepare-download endpoint, through which you can cue the generation of a new report.
• We've added a new GET /messages/download/{progressToken}/content endpoint, by which you can download a report once it has been generated.

Settings API

This API allows the retrieval of information about settings on your Preservica system.

Changes since 8.2

• We've amended the existing GET /storage/config/profiles endpoint to add an optional expand parameter, which can be used to get the names of storage adapters along with their IDs.