Creating an IBM Cloud API key

Use this information to create an IBM® Cloud API key that your deployed integration can use to authenticate to your IBM App Connect on IBM Cloud instance, in order to access the cloud-managed connectors and accounts that were referenced in the exported flow.

Note: This task is applicable only if you are deploying an integration server at version or earlier, and you want your deployed integration to use cloud-managed connectors to run one or more operations that are defined in your BAR file configuration. You can skip this task if your deployed integration will be configured to use only local connectors in your cluster.


You can create an IBM Cloud API key by using IBM Cloud Identity and Access Management (IAM), as in the following steps:

  1. Ensure that you are logged in to the same IBM Cloud account as the App Connect on IBM Cloud instance that your deployed integration will need to communicate with.
  2. Create an API key as follows:
    1. Click Manage > Access (IAM) > API keys to open the API keys page (URL:
    2. Ensure that My IBM Cloud API keys is selected in the View list.
    3. Click Create an IBM Cloud API key, and then specify a name and description.
    4. Click Create.

      Creating an API key using IAM

    5. Click Download to download the API key to a file named apiKey.json in your browser’s default location for later use.

      Downloading the IAM API key

    • In a subsequent task, you’ll create a configuration object to store this API key, and then configure the deployed integration to use that configuration to authenticate to the App Connect on IBM Cloud instance.
    • You can create a single IBM Cloud API key per App Connect instance, and then use that API key to create a different secret for each BAR file that you deploy as an integration server.

      Alternatively, you can create multiple IBM Cloud API keys per App Connect instance, and then use any of those keys to create secrets for your exported BAR files. If you decide to delete an IBM Cloud API key, be aware that API calls from all deployed integration servers that use that key, will fail.

What to do next