IBM Cloud Docs
Deleting key templates

Deleting key templates

You can delete your key templates in Unified Key Orchestrator with the UI, or programmatically with the Unified Key Orchestrator API. After you delete the key template, you can no longer create managed keys based on this key template.

Deleting key templates with the UI

To delete a key template, you need to destroy all keys that are created with the template and remove them from the vault first. For more information, see Deleting managed keys.

Follow these steps to complete the process:

  1. Log in to the Hyper Protect Crypto Services instance.

  2. Click Key templates from the navigation to view all the available key templates.

    You can also view archived key templates by clicking the Show archived templates icon Show archived templates icon on the table.

  3. Locate the key template that you want to delete, click the Actions icon Actions icon, and select Delete to remove the key template.

  4. Click Delete key template to confirm the deletion.

    Alternatively, locate the key template that you want to delete, click the Actions icon Actions icon, and then click Show details. A side panel is displayed to show the key template properties, click Actions > Delete.

The key template is deleted from the vault. You can no longer create managed keys based on this key template.

Deleting key templates with the API

To delete a key template through the API, follow these steps:

To delete a key template, you need to destroy all keys that are created with the template and remove them from the vault first. For more information, see Deleting managed keys.

  1. Retrieve your service and authentication credentials to work with key templates in the service.

  2. Delete a key template by making a DELETE call to the following endpoint.

    https://uko.<region>.hs-crypto.cloud.ibm.com:<port>/api/v4/templates/<id>
    

    Replace <id> with the ID of your key template.

    For detailed instructions and code examples about using the API method, check out the Hyper Protect Crypto Services Unified Key Orchestrator API reference doc.

What's next