API Gateway 10.11 | Administering API Gateway | Operating API Gateway | Data Management | Data Backup | Platform Data Backup | Creating Platform Data Backup using Script
 
Creating Platform Data Backup using Script
The script saves the platform data backup in the YML format.
Pre-requisites:
*Ensure that you have the API Gateway running during backup.
*Ensure that you have the repository where you want to save the platform data backup.
*To take backup of platform data
1. From the command prompt, go to SAGInstallDir/IntegrationServer/instances/instance_name/packages/WmAPIGateway/cli/bin.
2. Run the following command to create a backup in the default location:
Linux
./apigatewayUtil.sh export platformConfiguration -url URL of the instance
-username User name to access the URL -password Password to access the URL
-filePath Location where the backup must be saved
Windows
apigatewayUtil.bat export platformConfiguration -url URL of the instance
-username User name to access the URL -password Password to access the URL
-filePath Location where the backup must be saved
You can include the following parameters to customize the backup as per your requirements.
Parameter
Description
password
Password required to access the specified instance (from where the platform data backup is taken). If you want to avoid providing the password in clear text when running the apigatewayutil script, you can skip this parameter. When you run the command without the password parameter, then you will be prompted to enter the password. You can provide the password in hidden characters.
logLevel
Allows you to specify the required level of log that you want to create. Log levels indicate the severity of logs. Available levels are:
*Info. Provides the list of regular events that occur during the process. These events are informative.
*Debug. Provides the events that could be useful, if you have to debug the process.
*Warning. Indicates unexpected events that occurred during the process. Usually, these events do not interrupt or have an immediate effect on the process.
*Error. Indicates the events that stop the functionality from working as designed.
*Trace. Provides a much detailed events that could be useful for debugging.
You can specify one of the log level with the logLevel parameter. For example, to create a log file of Warning level when listing backup files, you can run the following command:
apigatewayUtil.bat list backup -logLevel warning
When you provide Error as the log level, then only the error level logs are saved. When you provide Debug as the log level, then Debug, Info, Warning and Error level logs are saved. When you provide Trace as log level, then all level logs are saved.
This parameter is optional. If you do not specify the parameter, then the Info level logs are saved by default.
logFileLocation
Allows you to provide the location where you want to save the log file.
For example, to save the log file in C:/apiglogs/backups, you can provide the location as seen in the following example:
apigatewayUtil.bat create backup -name samplebackup
-logFileLocation C:/apiglogs/backups
This parameter is optional. If you do not specify the parameter, the logs are saved in the following location SAGInstallDir/IntegrationServer/instances/instance_name/packages/WmAPIGateway/cli/logs/APIGWUtility.log