Restoring an API Connect cloud

You can revert to a previous configuration of your IBM® API Connect on-premises cloud by restoring servers that have been backed up.

About this task

This procedure describes how to restore an entire API Connect cloud from backup, eliminating any existing Management servers and replacing them with Management servers captured at a previous time. As a result, the contents of the API Connect cloud, such as Users, APIs, and Products, are reverted to their state at the time of backup.

For VMware, restore the appropriate snapshot or backup, depending on the mechanism that you originally used to back up the virtual machine.

Note: If you restore only a subset of the Management servers in your cloud, the servers that are not restored cannot continue to run alongside the restored servers. Therefore, for best results, restore all Management servers. If, however, you do not restore all Management servers, the cloud can function provided that you restore the following minimal subset of servers:
  • The Management server that was the primary server at the time of the backup operation.
  • At least half of the Management servers that were secondary servers at the time of the backup operation.
For example, if the cloud had three Management servers at the time of the backup operation, you must restore the primary server and at least one of the secondary servers. If you do not restore a sufficient number of Management servers, the cloud will not function.

Procedure

  1. Turn off all running Management servers.
  2. Turn off all running Developer Portal servers.
  3. (Optional): If you have a backup of the DataPower appliances, you can restore them at this point.
  4. Restore the Management server that was the primary server at the time of the backup operation.
  5. Restore all the Management servers that were the secondary servers at the time of the backup operation.
  6. Restore all Developer Portal servers.
  7. If you changed the user ID or password of any of your Management servers, you must update these credentials in the API Connect cloud console.
    Important: The restored backup includes the credentials that are defined in the cloud when the snapshot was captured. If you do not change these credentials to match the newly restored servers, the cloud console cannot communicate with the servers.
  8. If you restored your DataPower appliances with backup data not taken at the same time as the Management backup, you must remove and re-add each Gateway Server to their Gateway Clusters. This ensures that each Gateway Server contains up-to-date information. If the DataPower appliance was restored from a different backup, after you remove the Gateway Server in the CMC, you may also need to delete the APIMgmt domain in the appliance to ensure it is added back correctly.