How to Manage API Keys

Step-by-step instructions for managing your API Keys

Introduction

You may want to roll an API key if it is compromised and you need to block it and generate a new one. When rolling an API key, you can choose to block the old key immediately or allow it to work for a limited time interval, providing you with time to make the transition.

You may also want to add new API Keys for each new server you need to encrypt or decrypt data on securely with your Registered or Authorized Applications. Likewise, you may want to delete API Keys when they are no longer needed.

Manage API Keys

  1. On the left side menu click API:

  1. The API Keys screen appears showing your Registered Application API Key(s). You can also select the down-arrow on the right-side of each row to expose any Authorized Application API Key(s).

  1. Roll or Delete any Application API Key by selecting the three dots (...) at the end of every row. The following pop-up menu will appear:

  1. To roll an API Key: select the Roll key link and you will be presented with the following additional pop-up:

Continue by selecting the expiration date followed by pressing the Roll API Key button. You will be required to authenticate with your authenticator application one-time passcode to complete the action.

  1. To delete an API Key: select the Delete Key link and you will be presented with the following additional pop-up:

Once you select the Delete button, you will be required to authenticate with your authenticator application one-time passcode to complete the action.

Adding API Keys

You add new API Keys to any Registered or Authorized Application by selecting the + New API Key button located on the right of each Application row. API Key Credentials are automatically generated and presented to you:

Acquire your API Key Credentials by clicking the Copy button in the popup. It is very important that you save these credentials so that you’ll have them available for use. These credentials will not be accessible later If you Close the popup window without copying them.

🚧

Confidentially of these API Key Credentials is also critical to protecting encrypted data. For these reasons, the Credentials should be stored in a well-managed and backed up secret management server or password vault.