Archiving and unarchiving key templates

You can archive your key templates if they are not to be used, and unarchive them later if needed. You can perform archive or unarchive a key template in Unified Key Orchestrator with the UI, or programmatically with the Unified Key Orchestrator API.

You can view archived key templates by clicking the Show archived templates icon Show archived templates icon on the table. After the template is archived, you cannot edit the distribution of keys created with the template, and you can no longer create managed keys with the archived key template. However, you can still use the keys for cryptographic operations.

Archiving key templates with the UI

To archive the key template, complete the following steps:

Log in to the Hyper Protect Crypto Services instance.
Click Key templates from the navigation to view all the available unarchived key templates.
Locate the key template that you want to archive, click the Actions icon , and select Archive.

Alternatively, locate the key template that you want to archive, click the Actions icon , and then click Show details. A side panel is displayed to show the key template properties, select Actions > Archive.
Check the box for Key template will not be accessible and click Archive key template.

After the template is archived, you cannot edit the distrubution of existing key that are created with the template, and you can no longer create managed keys with this key template. However, you can activate the key template again by unarchiving it.

Archiving key templates with the API

To archive the key template through the API, complete the following steps:

Retrieve your service and authentication credentials to work with key templates in the service.
Archive a key template by making a POST call to the following endpoint.
```
https://uko.<region>.hs-crypto.cloud.ibm.com:<port>/api/v4/templates/<id>/archive
```
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.

Unarchiving key templates with the UI

To unarchive the key template, complete the following steps:

Log in to the Hyper Protect Crypto Services instance.
Click Key templates from the navigation to view all the available unarchived key tamplates.
View archived key templates by clicking the Show archived templates icon on the table.
Locate the key template that you want to unarchive, click the Actions icon , and choose Unarchive.

Alternatively, locate the key template that you want to unarchive, click the Actions icon , and then click Show details. A side panel is displayed to show the key template properties, select Actions > Unarchive.
Click Unachive key template.

You can then use the key template to create keys and edit the key template properties again.

Unarchiving key templates with the API

To unarchive the key template through the API, complete the following steps:

Retrieve your service and authentication credentials to work with key templates in the service.
Unarchive a key template by making a POST call to the following endpoint.
```
https://uko.<region>.hs-crypto.cloud.ibm.com:<port>/api/v4/templates/<id>/unarchive
```
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

To find out instructions on creating a key template, check out Creating key templates.
To find out instructions on managing a key template, check out Editing key template details.
To continue to create keys with the key template created, follow the instruction in Creating managed keys with a key template.
To find out instructions on deleting a key template, check out Deleting key templates.