API Gateway Backup and Restore Commands
You can use a command-line interface (CLI) script to back up data that is stored on API Gateway database. You can use the CLI script to restore database after a data failure or hardware failure on the API Gateway instance.
In a command line, go to <Integration Server_directory>\instances\default\packages\WmAPIGateway\cli\bin and run the following commands to take a database backup or restore the database from a backup:
If you want to... | Command |
Backup data | apigatewayUtil.sh create backup -name <backupFilename> |
Backup custom data | apigatewayUtil.sh create backup -name <backupFile_name> -include <reference name> Possible values for the parameter reference name:  analytics - to back up analytical data. assets - to back up asset data. |
Delete the backed up data | apigatewayUtil.sh delete backup -name <backupFile_name> |
Restore the backed up data | apigatewayUtil.sh restore backup -name <backupFile_name> |
To retrieve all available backup files in the repository | apigatewayUtil.sh list backup |
Delete a repository from API Gateway | apigatewayUtil.sh delete manageRepo |
To retrieve all available repositories | apigatewayUtil.sh list manageRepo |
To configure a repository in S3 | apigatewayUtil.sh configure manageRepo -file <file_path> |
Pre-requisites for Backing up and Restoring Data
The following points are to be considered in the API Gateway instances used for backup and restore:
The
Software AG root installation directory must be the same.
The
Integration Server instance name must be the same.
The ports defined for the
API Gateway webApp,
Integration Server, and the API Gateway Data Store must be the same.