API

Developer Blog - API Updates in Preservica 7.3

Lukasz Sadowski

June 19th, 2024

This post provides you with a summary of the API updates we have made in Preservica 7.3.

Preservica 7.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 around the middle of 2024.

Deprecation of Basic Auth

Using Basic Auth to access these endpoints is now deprecated as we explained at Preservica 7.1. If you are using automation (e.g. scripts) to access these APIs, please change them over to using access token based authentication.

Auth - Certificates API

API to manage certificates used during authentication.

New API endpoints since 7.3 (all require authentication):

  • GET /auth/certificates retrieves the certificates stored for authentication purposes. The response will tell you whether you have a private key, but the key itself won't be retrieved.
  • POST /auth/certificates adds information about a single certificate stored for authentication purposes. The private key won't be retrievable, so you should ensure you have a securely stored copy outside Preservica if you need it. Requires TenantManager permission, via a role: ROLE_SDB_ADMIN_USER, ROLE_SDB_MANAGER_USER.
  • GET /auth/certificates/{id} retrieves information about a single certificate stored for authentication purposes. The response will tell you whether you have a private key, but the key itself won't be retrieved.
  • PUT /auth/certificates/{id} updates information about a single certificate stored for authentication purposes. The private key won't be retrievable, so you should ensure you have a securely stored copy outside Preservica if you need it. Requires TenantManager permission, via a role: ROLE_SDB_ADMIN_USER, ROLE_SDB_MANAGER_USER.
  • DELETE /auth/certificates/{id} removes information about a single certificate.Requires TenantManager permission, via a role: ROLE_SDB_ADMIN_USER, ROLE_SDB_MANAGER_USER.

Auth - Trusted Urls API

API to manage trusted urls.

New API endpoints since 7.3 (all require authentication):

  • GET /auth/trusted-urls retrieves the list of urls that the auth service will trust for a tenant. Requires TenantManager permission, via a role: ROLE_SDB_ADMIN_USER, ROLE_SDB_MANAGER_USER.
  • POST /auth/trusted-urls add a list of urls that the auth service will trust for a tenant. This will add to any existing urls and will not replace any existing trusted urls. Requires TenantManager permission, via a role: ROLE_SDB_ADMIN_USER, ROLE_SDB_MANAGER_USER.
  • DELETE /auth/trusted-urls deletes a list of trusted urls. Requires TenantManager permission, via a role: ROLE_SDB_ADMIN_USER, ROLE_SDB_MANAGER_USER.

More updates from Preservica

API

Configuring Auto-Migration Policies via API Endpoints

Six months ago, with the release of version 7.3, we added the ability to configure your auto-migration policies via the Next-Generation Interface. In most cases, this page is all you need to tailor the preservation process to your exact needs. However, there may be situations where you want to adjust your migration policies via code, and in this article, we will cover the API endpoints that allow for that.

John Gabriel

November 29th, 2024

API

Developer Blog - API Updates in Preservica 7.5

This post provides you with a summary of the API updates we have made in Preservica 7.5.

Richard Smith

October 28th, 2024

API

Auto Re-Characterise Blog

The last few Preservica releases have come with announcements of Automated Digital Preservation (ADP) features starting to appear in our New Generation Interface.

Jack O'Sullivan

October 28th, 2024

API

Developer Blog - API Updates in Preservica 7.4

This post provides you with a summary of the API updates we have made in Preservica 7.4.

Sam Marshall

October 28th, 2024

Preservica on Github

Open API library and latest developments on GitHub

Visit the Preservica GitHub page for our extensive API library, sample code, our latest open developments and more.

Preservica.com

Protecting the world’s digital memory

The world's cultural, economic, social and political memory is at risk. Preservica's mission is to protect it.