Developer Blog - API Updates in Preservica 8.2

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

Preservica 8.2 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.

Authentication API

API for managing user authentication.

Changes since 8.1

• /complete_2fa requires the content type to be set to application/x-www-form-urlencoded. The request body already had to be structured for this, but the content type wasn't being enforced.

Entity API

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

Changes since 8.1

• Deletion related endpoint are now restricted to users with the Data Management functional permission, that covers /actions/final-deletions, /actions/recoveries and /deleted-entities
• You can now trigger policies to be re-evaluated against a list of entities via POST /actions/policy-evaluations

Process API

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

Changes since 8.1

• You can set an option on Incrmental Ingests to not fail on matched folders if they have different parents than expected. This can be set when creating (POST /ingests/configs) or updating a config (/ingests/configs/{id}).

Process Monitor API

The Process Monitor API lets you see information about ongoing processes and messages associated with them.

Changes since 8.1

• Listing of monitors can now be filtered on errors, warnings, started and updated via GET /monitors.
• Listing of monitors can also now be sorted and paged via GET /monitors.
• Individual monitors can now be retrieved using workflow correlation tokens (i.e. the progress token returned by apis that start workflows) via GET /monitors/{id}.
• Messages listed via GET /messages now include messageKey separate from the message. (This only applies to messages created after 8.2.)
• Listing of messages can now be filtered on messagekey and entityRef via GET /messages.
• Listing of monitors can also now be sorted via GET /messages.
• Unique message keys for a monitor can be listed via GET /messages/keys.

Settings API

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

Changes since 8.1

• Metadata enrichment now includes image analysis which can be enabled via POST /metadata-enrichment/config/profiles, GET now shows if image analysis is enabled on a profile, and PUT allows enabling / disabling it.
• Credentials for image analysis can be listed, created and updated via endpoints like /metadata-enrichment/image-analysis/credentials.
• Storage Profiles and Rules can now be listed, created and updated via endpoints like /storage/config/profiles and /storage/config/rules.

Workflow API

This API lets you control most aspects of workflow management, including starting, stopping and terminating workflows, submitting results to tasks which normally require human interaction, and uploading definitions and contexts.

Changes since 8.1

• Workflow instance details now include the process monitor api id such as returned via GET /instances/{id}.