Generating API Key

About this task

webMethods API Gateway uses API key to authenticate the configured destination. An API key is a unique identifier for an application or user accessing an API. API keys verify the identity of the client making the request to an API. They can also grant access to specific resources or functionalities within the API.

Procedure

  1. From the IBM SaaS Console Subscriptions page, find the subscription to which you want to add an API key and click View instances.
  2. In the table on the Instances tab, click the row of the instance where you want to add the API key.
  3. From the instance, select the API Keys tab and click Generate key. The Generate API key window opens.
  4. Choose a service ID, enter an API key name, optionally add a description, and select an expiration date.
  5. Click Generate key. The API key successfully created window opens.
  6. To copy the API key, click Copy to clipboard. You have a limited amount of time to copy the API key. The API key is unrecoverable. If lost, it must be reset.
  7. Close the window. The API key appears in the table on the API Keys tab.
  8. To update the access for an API key, update access for the service ID or user. API keys are associated with a service ID or user and have the same access that they do across all accounts.