API keys

GuardiumĀ® Insights offers a settings page that allows you to generate application programming interface (API) keys which you can then use for authentication to the interactive API or as basic keys for authentication in cURL commands.

Before you begin

To open the settings menu, select Settings (main menu). After opening the settings menu, choose Manage API keys.

Procedure

  1. Click Create API key to open the Create API key panel.
  2. Enter a description for the key in the API key description field. This description will be used to distinguish this key from other keys that you generate.
  3. Click Create API key.
  4. After you generate the key, the Retrieve section displays. In this section, you can:
    • Copy the API key by clicking its copy to clipboard icon.
      Important: This key is what you will use as a Username when accessing the Guardium Insights API user interface.
    • Copy the key secret by clicking the Secret API key copy to clipboard icon.
      Important:
      • This key secret is what you will use as a Password when accessing the Guardium Insights API user interface.
      • The key secret cannot be accessed again after you close the Create API key panel. To be able to use the key secret, you must copy it to the clipboard before closing the panel. After copying it to the clipboard, use a secure means for storing the key secret.
    • Copy the Encoded token by clicking its copy to clipboard icon. This token can be used for calling the Guardium Insights API from cURL commands.
      Important: The encoded token cannot be accessed again after you close the Create API key panel. To be able to use the encoded token, you must copy it to the clipboard before closing the panel. After copying it to the clipboard, use a secure means for storing the token.
  5. Click Done to close the Create API key panel and return to the settings page.

Results

All API keys that you create appear in the table in the API keys settings page. In this page, you can view your keys and you can remove individual keys permanently by clicking the Delete API key trash icon next to the key.

Once you have keys in place, you can use them to access the API user interface and sign API requests.