IBM API Connect best practices

Consider implementing the following best practices for optimizing your IBM® API Connect cloud.

• Define two Management servers to ensure High Availability (HA) and failover.
• Upgrade all defined servers at the same time to keep the versions synchronized.
  To determine the version on a virtual appliance, complete these steps:

  1. Log on to the CLI on the appliance through a Secure Shell (SSH).
  2. Enter the following command:

     system show version

  To determine the version on a physical appliance, refer to the instructions provided with the appliance.

  Ensure that the minimum software and hardware requirements are installed. For more information, see IBM API Connect Version 5.0 requirements.
• Take a backup of the Management server periodically to ensure that you have a backup of the IBM API Connect configuration information. For more information, see Preserve your cloud data.
• When you create a custom dashboard for viewing analytics data, or when you update an existing dashboard, export the definition of the dashboard to retain a backup copy. It is possible for the dashboard to become inaccessible if the Elasticsearch index that stores the definition becomes corrupted. See Exporting dashboards for the procedure.
• Check the health data of your Management servers with REST APIs. See Obtain health check data of Management servers by using REST API calls for more information.
• Test the health of your Management servers and database regularly by running the stat show apiconfig command in the Command Line Interface. This indicates whether your database is healthy. For more information, see Testing Management servers.