Managing platform REST API keys

Create API keys associated with your user account, and then use them to authenticate when you call the platform REST APIs provided by API Connect.

About this task

The API Connect platform REST APIs require authentication for use. To call an API interactively, you can log into the toolkit CLI with an option to generate the API key. To call an API programmatically, you can generate an API key and then exchange it for an API Connect access token. This requirement applies only to the APIs that are provided by API Connect. You do not need the API key for calling APIs that you imported or created. The API key is intended for use with the OIDC user registry type.
Remember: By default, API keys are configured to be used only
once. However, you can customize the configuration and modify the API lifespan by following the
steps provided in the Configuring API key settings
topic.

Procedure

  1. Create an API key:
    1. Log in to API Connect.
    2. On the API Keys page, click Add.
    3. In the "Create API Connect API Key" box, provide a title for the key (unique within your user account) and a description; then click Create.

      The button is disabled until you provide a description.

  2. Manage API Keys:
    1. Log in to API Connect.