Frequently asked Questions

The following IBM API Connect frequently asked questions and answers provide you with general and frequently used or required installation, configuration, and replication-related information.

IBM API Connect

IBM API Connect is an end-to-end solution that allows users to create, secure, manage, socialize, monetize and analyze APIs. It provides a powerful set of capabilities from turning backend RESTFUL or SOAP services into managed services. This is done by publishing APIs to API Gateways while enforcing lifecycle and governance controls on those APIs. API Connect enables users to expose APIs, through a developer portal, targeting application developers both inside and outside their organization. Additionally, the solution’s analytics tooling helps API providers and API consumers better understand the health and consumption of deployed APIs.

Read the following IBM API Connect frequently asked questions and answers.

In IBM API Connect, we have used the “crypto” module and use “aes256-cbc” algorithm.

Our consumer team uses Node.js language and they are getting issues while using “aes256-cbc” algorithm at their end.

Can we need to maintain the same version on Consumer and API end? 

if yes, please guide how to check the version of the crypto module.

Moving to a new stack has given us the opportunity to streamline the Analytics experience to enable users to access and analyze analytics data easier. In the past Analytics has only been available from within a single catalog or space and now you will now also be able to have NEW access an Analytic Service data across multiple Catalogs in a Provider Organization and across multiple Provider Organizations from the Cloud Manager.

Use the apicops operations tool to check the health, troubleshoot, and run maintenance operations on your API Connect installation.

API Connect Upgrade Central provides a quick guide to upgrading API Connect releases, with tabs that offer additional information on upgrade and migration paths:

  • For an overview of the upgrade and migration process, see the “Getting Started” tab.
  • For information about migrating from version 5 to version 10, see the “v5 to v10” tab.


  • Run the following command to check the label on the worker nodes:

oc get nodes -l

If the response shows the following message, then the power cycle did not cause a problem and you can skip the rest of this task:

No resources found

If the response looks like the following example (the IP address will be different), proceed to the next step:

NAME                                         STATUS   ROLES    AGE   VERSION    Ready    worker   27h   v1.19.0+8d12420


  • Run the following command to correct the problem:

for i in $(oc get nodes -l|grep worker|awk ‘{print $1}’); do echo $i;  oc label nodes $i`echo $i|awk -F’.’ ‘{print $1}’` –overwrite=true; done

If you cycle the power on an API Connect cluster that is deployed on OpenShift or Cloud Pak for Integration, you might need to reset the IP address for the

  • Cloud-based S3 storage
    • IBM Cloud Object Storage
    • AWS S3
  • SFTP
    • In, SFTP backup/restore procedure is automatically handled by apiconnect operator.
    • In, local Backups can be stored remotely on an sftp server, and retrieved later from the sftp server for restore operations. See Using an sftp server for backup files (
  • Local storage backups

IBM API Connect has flexible licensing options that include both processor-based and consumption-based (API calls) models.  Consider the following data points when upgrading/migrating.

  • Customers with IB
  • M API Connect Enterprise Edition licensed under a compute-based model (i.e. PVU / processor value units), may simply move forward to a newer version using their existing licensed entitlements.
  • If you are consuming (or plan to consume) multiple styles of integration (API integration, App Integration, Messaging, Events) you may want to consider upgrading from IBM API Connect Enterprise PVU licenses to a multi-style integration platform,  IBM Cloud Pak for Integration.  This provides a single license with deployment flexibility across multiple integration capabilities.
  • Customers seeking to move to consumption-based licensing (in place of existing compute capacity licenses) can upgrade from their PVU licenses to a Subscription based on API Call volumes. This can simplify planning for growth based on business metrics like API consumption. This approach may also be more cost-effective for some highly available topologies, hybrid and multi-cloud deployments.
  • Deploy the Analytics subsystem by applying the analytics_cr.yaml CR to the cluster as explained in Installing analytics.
  • Restore your local copy of the original AnalyticsCluster CR by running the following command:
  • kubectl apply -f gj01-analytics.yaml
  • Replace gj01-analytics.yaml with the file name that you used for your saved CR.
  • Restore the Analytics data from a back up, as explained in Restoring the Analytics database.

There are four widely agreed-upon types of web APIs: open APIs, partner APIs, internal APIs, and composite APIs.

Ideally, the technical owner of an API should be from the team that has built the API. If there is no DevOps culture (an API is built by one team and operated by another team), a technical API owner should be as