GitHubContribute in GitHub: Edit online

Filtering and searching keys

You can filter and search for your managed keys in UKO with the UKO web interface, or programmatically with the UKO API.

Filtering keys with the UKO web interface

To filter keys by using the web interface, complete the following steps:

  1. Log in to UKO.

  2. Click Managed keys from the navigation to view all the available keys.

  3. Click the Filter icon Filter icon in the table.

  4. Specify the filter criteria as you need, and click Apply.

    You can set the following filter criteria.

    Table 1. Filter managed keys
    Property Description
    Vault The vault that controls access to the managed key.
    Key template The key template with which the key is created.
    Activation Set a date range of when you activated the key.
    Expiration Set a date range of when you deactivated the key.
    Creation Set a date range of when the key was created.
    Keystore types The type of keystore where the key is stored.
    Algorithm The encryption algorithm to encrypt data for the key.
    Minimum key length The minimum number of bits that represents the encryption strength of the key.
    Maximum key length The maximum number of bits that represents the encryption strength of the key.
    State Key states include Pre-active, Active, Deactivated, and Destroyed.
    Last rotated The time range when the key was last rotated.

Searching for keys with the UKO web interface

To search for a key by using the web interface, complete the following steps:

  1. Log in to UKO.
  2. Click Managed keys from the navigation to view all the available keys.
  3. To search for key name or description, type a word in the search bar.

Searching keys with the API

To search for a managed key by ID through the API, follow these steps:

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

  2. Retrieve a managed key and its details by making a GET call to the following endpoint.

    https://<hostname>:<port>/api/v4/managed_keys/<id>
    

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

    For detailed instructions and code examples about using the API method, check out the Cloud API reference doc.

What's next