Hyper Protect Crypto Services key management service API change log

In this change log you can learn about the latest changes, improvements, and updates for the Hyper Protect Crypto Services key management service API. The change log lists changes that have been made, ordered by the date they were released. Changes to existing API versions are designed to be compatible with existing client applications.

API versioning

The latest released version is 23.11.

February 2024

The following methods are updated:

Delete key ring: You can now force delete a key ring. If the keys in this key ring are not deleted before this action is performed, the keys will be moved to the default key ring.
List key versions: You can now view key versions of a key in any state, including the deleted key.

February 2023

The following methods are added:

List Keys with sorting to include lastRotateDate sorting.
List Keys with advanced filtering to including lastRotateDate filtering.
Create key with policy overrides to enable users with Manager role to create keys with policies in a single call, overriding instance level policies.
Disable a key rotation policy to allow an automatic key rotation policy to be paused temporarily.

January 2022

The following methods are added:

Update the key ring of a key. After you create a key, you can transfer the key to a different key ring by sending a PATCH /api/v2/keys/{id} request and specifying the new key ring ID.
Purge key to permanently delete a key. After you purge a key, you are no longer able to access the key and its associated resources. This action is performed in a DELETE /api/v2/keys/{id}/purge request.

April 2021

The method of restoring keys is updated. Now all root keys and standard keys can be restored within 30 days of the deletion and no key material is required.