Generating API keys for authentication

With an API key, you can automatically authenticate to IBM Data Product Hub from a script or application. Your API keys are associated with your credentials and are specific to you. With API keys, you can authenticate without entering your password.

You can also generate a new API key programmatically by using the Get API key endpoint. However, this endpoint requires a ZenApiKey authorization token or Bearer token, and it is not recommended.

Your platform API key enables scripts and applications to access everything that you would typically be able to access when you log in to the IBM Data Product Hub web client. An instance API key enables access only to the specific instance that it is generated from.

Important: Be sure to store your API keys somewhere safe. If you lose an API key, you need to create a new key and update any scripts or applications where the key is used.

Platform API key

With a platform API key, you can access everything that you would typically be able to access when you log in to the IBM Data Product Hub web client.

To generate a platform API key:

  1. Log in to the web client.
  2. From the toolbar, click your avatar.
  3. Click Profile and settings.
  4. Click API key > Generate new key.
  5. Click Generate.
  6. Click Copy and save your key somewhere safe. You cannot recover this key if you lose it.

If you lose your API key, repeat the preceding steps to generate a new API key. Your old API key becomes invalid, and any applications or scripts cannot authenticate to the platform until you provide your new API key.

If you believe that your API key is compromised:

  1. Log in to the web client.
  2. From the toolbar, click your avatar.
  3. Click Profile and settings.
  4. Click API key > Revoke current key.
  5. Click Revoke.

Any applications or scripts that use the key won't be able to authenticate to the platform.

API tokens

To generate an API authorization token, use one of the following methods.