Creating an API key
To allow applications to communicate directly with platform services such as IBM® X-Force® Exchange, you must provide an API key.
About this task
The API key is a two part string, consisting of a unique identifier and a secret token, which is used for authentication to the API endpoint. The Unique Identifier is comparable to a user ID and has a set of access rights specific to an identity associated with it. The secret token, comparable to a password, is a code that is used together with the Unique Identifier to verify the identity of the calling process to the API.
To keep your key secure, delete the key after 90 days and create a new one.
Procedure
- In the home page, click the Menu icon.
- Under General settings, click API Keys and then click Create API key.
- In the API key name field, enter a unique and meaningful name that identifies the key for you.
- Click Generate.
Results
When your key is created, the Create API key pane provides the API Key details: a unique identifier and a secret token are assigned.
.txt).Viewing an API key
You can view a list of existing from the API keys page.
Procedure
- In the home page, click the Menu icon.
- Under General settings, click API Keys.
- On the API keys page, you can see details for the existing keys that you created. The row of values for each key contains the name that you provided and the unique identifier that is assigned. Last modified contains the creation date or the most recent date when you modified the key name.
Deleting an API key
You can easily delete an API key that you no longer need.
Procedure
- In the home page, click the Menu icon.
- Under General settings, click API Keys.
- Hover over the row that contains the key you want to delete.
- Click the delete icon.
- Click Delete.