Generating API keys for authentication
With an API key, you can automatically authenticate to IBM Software 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.
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 Software Hub web client. An instance API key enables access only to the specific instance that it is generated from.
- What level of access is required?
- As a security best practice, it is recommended that you give the least amount of access necessary to the script or application. For example, if a script needs to interact only with a specific service instance, generate an API key for that service instance.
- What type of key can I generate?
- Some services do not support instance-level API keys. If you cannot generate an API key that is specific to the service, you must use your platform API key.
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 Software Hub web client.
To generate a platform API key:
- Log in to the web client.
- From the toolbar, click your avatar.
- Click Profile and settings.
- Click .
- Click Generate.
- 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:
- Log in to the web client.
- From the toolbar, click your avatar.
- Click Profile and settings.
- Click .
- Click Revoke.
Any applications or scripts that use the key won't be able to authenticate to the platform.
Instance API keys
If you have access to a specific instance of a service, you can generate an API key to access only that service instance.
To generate an instance API key:
- Log in to the web client.
- From the navigation menu, select .
- Click the name of the instance for which you want to generate an API key.
- Click .
- Click Generate.
- 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 instance until you provide your new API key.
If you believe that your API key is compromised:
- Log in to the web client.
- From the navigation menu, select .
- Click the name of the instance for which you want to revoke your current API key.
- Click .
- Click Revoke.
Any applications or scripts that use the key won't be able to authenticate to the instance.