Creating API keys

Edit online

Use Guardium® Data Security Center APIs (application programming interfaces) to interact with other applications, such as Guardium Data Protection, universal connectors, and Guardium Data Security Center reports.

Before you begin

You can generate API keys from the Guardium Data Security Center API keys page. You can then use the keys to authenticate to the interactive API.
Attention: Guardium Data Security Center includes several different subscription plans. Each subscription plan has different privileges and certain APIs are available only with certain subscription plans. Therefore, your Guardium Data Security Center instance might not support some of the APIs that are available in the Insights SaaS API Reference).

If you run an API that your subscription does not support, Guardium Data Security Center returns an error message.

Note: Premium You can also create and use an OAuth authorization token, as described in Accessing Guardium Data Security Center APIs with OAuth.

From the Guardium Data Security Center API keys page, you can link to the API reference landing page, and then to the API reference, which lists the available APIs.

Procedure

  1. To see the various settings, open the main menu. Open this menu by clicking the main menu icon (main menu). Then click Preferences > Authentication > API keys.
  2. Click Create API key to open the Create API key window.
  3. In API key description, enter a name for this key. The description distinguishes this key from other keys that you generate.
  4. Click Create API key to generate the key. The window displays the following information that you need to use the APIs.
    Important: After you close the Create API key page, you cannot access the information on the page. Click the Copy icon icon next to the element to copy the information for that element (that is, the API key, Secret API key, or Encoded token). Then, paste that information to another location (such as a text file). When you are done, store this information securely.
    • API key - Use this key as the Username when you access the Guardium Data Security Center API user interface.
    • Secret API key - Use the key secret as the Password when you access the Guardium Data Security Center API user interface.
    • Encoded token - Use this token to create the token header that you use to call the Guardium Data Security Center API. For more information, see Calling APIs.
  5. Click Done to close the Create API key window and return to the settings page.

Results

The API keys that you create appear in the table in the API keys settings page. You can view your key names without any encoded information. To remove the key, click the Delete icon icon next to the key that you want to delete.

After you create the keys and token, you can use them to call the APIs.