Generating an API key

To invoke the Concert API, you must authenticate your request using a valid API key secret which you can create from the Concert UI. You can use the Concert API for one-time or automated data ingestion or other supported functions.

Warning: API keys are unique identifiers that grant access to certain aspects of your Concert instance and configurations. Always store API keys securely and limit access authorized individuals in order to prevent unauthorized requests or security-related risk to your data. You cannot recover an API key if it is lost; in this case, you must generate a new one.

Instructions

Perform the following instructions to generate a new API key in the Concert UI.

  1. Log in to the Concert UI using your credentials or the configured SSO and multi-factor authentication.
  2. Click the user icon (circle) on the top right corner of the main navigation header, and select API key.
  3. Click Generate API key.
    Note: If you already created an API key, you are prompted to revoke it before generating a new key.
  4. Record the API key value and API key usage details and store these in a secure location.
    Warning: You cannot view the API key secret after closing the dialog box.

The API key usage example contains critical information you'll need to include in API header, including:

  • API key type: C_API_KEY for SaaS and VM deployments or ZenAPIKey for Concert deployments on an OCP cluster deployed using IBM Cloud Pak® foundational services. This value must precede the API key secret in the authentication header.
  • InstanceId: The unique ID of your Concert instance.

With a valid API key generated, you can start using it to authenticate requests. Refer to API reference and authentication for details on the various custom headers required to invoke the Concert API.

Refer to the https://developer.ibm.com/apis/catalog/concert--ibm-concert-api for a full index of endpoints and requests.