Backing up and restoring the management subsystem

You can back up and restore your Management subsystem in your VMware environment.

About this task

Note: These instructions apply to API Connect 10.0.1.1 or later. For API Connect 10.0.1.0-eus or earlier, see Backing up and restoring the management subsystem on VMware.
  • You use the apicup utility to configure backup settings for the management subsystem.
  • Database backups can be used to restore the database for disaster recovery.
  • Backups can be scheduled or generated manually (on-demand). You can then list what backups are available and then use one to restore your Management subsystem if required.
  • SFTP support:
    • In 10.0.1.0-eus, Local Backups can be stored remotely on an sftp server, and retrieved later from the sftp server for restore operations. For steps on uploading local-backup files to an sftp server, and for downloading local-backup files from a sftp server for the purposes of a restore, see Using an sftp server for backup files on VMware.
    • In 10.0.1.1-eus, SFTP backup/restore procedure is now automatically handled by apiconnect operator and SFTP documentation in the below sections are applicable to 10.0.1.1-eus and greater versions
    • If you upgrade API Connect from 10.0.1.0-eus to 10.0.1.1-eus, and configure SFTP for 10.0.1.1-eus, API Connect resyncs upstream sftp backups and creates relevant CRs of type record.
  • Postgres replica pods depend on a successful completed backup. If backup configuration is not correct, replica pods won't come up.
  • Restoring a backup restores the registration credentials (client_ID, client_secret) that were in use at the time that the selected backup was created. For information on the registration credentials, see Changing the registration client_id and client_secret for applications.
Note: You must backup both the Management and Portal subsystems at the same time, to ensure synchronicity across the services.
Types of backups supported:
  • Cloud-based S3 storage
    • IBM Cloud Object Storage
    • AWS S3
    • 10.0.1.2-eus or later: Any custom S3, such as minIO
  • SFTP

    In 10.0.1.1-eus, SFTP backup/restore procedure is now automatically handled by apiconnect operator.

  • Local Backups