IBM Cloud Docs
Editing internal keystores

Editing internal keystores

You can edit your internal keystores in Unified Key Orchestrator with the UI, or programmatically with the Unified Key Orchestrator API.

Editing internal keystores with the UI

To edit the details of an internal KMS keystore by using the UI, complete the following steps:

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

  2. Click Keystores from the navigation to view all the available keystores.

  3. Click the internal keystore that you want to edit. The Details side panel is displayed.

  4. Click Edit to update the Keystore name and Description.

    The keystore name must be of 1 to 100 characters in length. The first character must be a letter (case-sensitive) or digit (0-9). The rest can also be symbols (.-_) or spaces. The description can be up to 200 characters in length.

    You can filter and search the keys that are distributed to this keystore, but you cannot edit key details or change key states from the side panel. To edit the details of the keys, see Editing key details.

  5. Click Save to save the changes.

You can search for a specific keystore by using the search bar, or filter keystores based on your needs by clicking the Filter icon Filter icon in the Keystores table.

Editing internal keystores with the API

To edit the details of an internal keystore through the API, follow these steps:

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

  2. Update an internal keystore by making a PATCH call to the following endpoint.

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

    Replace <id> with the ID of your keystore.

    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