Backing up and restoring on VMware

Backup and restore API Connect on VMware.

Note: Backups are for recovery of the API Connect subsystems in the same VMware environment where the backups were taken.
If you want to restore API Connect subsystem backups in a different VMware environment, be aware of the following points:

  • Every API Connect network endpoint that was defined with apicup and all URLs specified in the API Connect UIs must resolve correctly in the new environment. For example, if you configured your platform API endpoint as platform.myapiconnect.com, that endpoint must be valid in your new environment.

    It is only possible to change endpoints for an API Connect deployment by following the form factor migration procedure.

  • If you did not use the original VM hostnames or IP addresses in your API Connect endpoints, then you can deploy your new VMs with different hostnames and IP addresses.

A complete API Connect VMware deployment backup consists of the following items:
  • Project directory backup.

    The original project directory that was created with the apicup command during the initial product installation is essential for disaster recovery.

  • Management certificates backup.

    Backup your management subsystem certificates by using the dr-preparation script.

  • Subsystem database backups.
    Your management, portal, and analytics subsystems all have databases that contain your API Connect configuration, which includes:
    • Everything that you create and configure in the Cloud Manager and API Manager UI (APIs, products, TLS profiles, user registries, and so on), or with the toolkit CLI or REST API.
    • Your developer portal sites and customizations made.
    • Your analytics data.

    Subsystem database backups can be configured to run automatically following a cron schedule.

Note: For information about how to maintain a two data center deployment, including backup and restore considerations, see Maintaining a two data center deployment.