Developer Blog - API Updates in Preservica 8.0

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

Preservica 8.0 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 the summer of 2025.

Admin API

This API allows you to configure your Preservica system.

Changes since 7.7

• Retrieving config events (via a GET to /config-events) now has an optional from query parameter. This is a start date from which events will be found and must be a full ISO-8601 timestamp, e.g. 2019-07-01T00:00:00.000+0100.
• Retrieving config events (via a GET to /config-events) now has an optional to query parameter. This is an end date up to which events will be found and must be a full ISO-8601 timestamp, e.g. 2019-07-01T00:00:00.000+0100.
• Retrieving config events (via a GET to /config-events) now has an optional category query parameter. This is a category type on which to filter events.
• Retrieving config events (via a GET to /config-events) now has an optional username query parameter. This is a username on which to filter events.
• Retrieving config events (via a GET to /config-events) now has an optional command_type query parameter. This is a command type on which to filter events.

Entity API

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

Changes since 7.7

• Creating a new retention policy (via a POST to /retention-policies) now has validation to prevent policies being created longer than 100 years.
• Retrieving recently updated entities (via a GET to /entities/updated-since) now has an optional endDate query parameter. This is an end date up to which records will be found and must be a full ISO-8601 timestamp, e.g. 2019-07-01T00:00:00.000+0100.
• There is now a new POST endpoint at /actions/exports which will initiate the export of one or more entities. By default this includes content, metadata with the latest active generations and no parent hierarchy.

Metadata API

The Metadata API allows you to manage the new view (Forms and Groups) of descriptive metadata.

Changes since 7.7

• There is now a new GET endpoint at /csv-templates/download} which will return a csv template or set of templates for a list of form IDs.

Process API

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

Changes since 7.7

• There is now a new GET endpoint at /ingest/configs which will list ingest process configurations.
• There is now a new POST endpoint at /ingest/configs which will add a new ingest process configuration.
• There is now a new GET endpoint at /ingest/configs/{id} which will return information about a given ingest process configuration.
• There is now a new PUT endpoint at /ingest/configs/{id} which will update a given ingest process configuration.
• There is now a new DELETE endpoint at /ingest/configs/{id} which will remove a given ingest process configuration
• There is now a new PUT endpoint at /ingest/configs/{id}/active which will activate or deactivate a given ingest process configuration.

Process Monitoring 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 7.7

• There is now a new GET endpoint at /monitors/{id} which will return information about a monitor.

Settings API

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

Changes since 7.7

• There is now a new GET endpoint at /metadata-enrichment/config/auto-enrichment which will get the current metadata enrichment mode.
• There is now a new PUT endpoint at /metadata-enrichment/config/auto-enrichment which will update the current metadata enrichment mode.