API Gateway 11.1 | Administering API Gateway | Operating API Gateway | Data Management | Data Backup | Advanced Backup Options | Verifying Backup Status
 
Verifying Backup Status
Monitoring the status of backups is crucial to ensure data integrity and to troubleshoot any issues that may arise during the backup process. If you initiated a backup with the query parameter wait_for_completion=true, you can check the status of the backup using the _status endpoint.
*To verify the status of a backup operation
1. Ensure your external Elasticsearch cluster is up and running.
2. Verify the backup status using the following command:
GET _snapshot/repo-name/backup-name/_status
In this command, replace repo-name and backup-name with your repository and backup names, respectively.
A sample command to verify the backup status is as follows:
curl -s -X GET http://es-host:es-port/_snapshot/myrepo/api_data_store_backup/_status
In this example:
*The external Elasticsearch cluster is assumed to be running on es-host with port es-port.
*The command queries the status of the backup named api_data_store_backup in the backup repository myrepo.
The JSON response from the external Elasticsearch provides detailed information about the status of the backup. The table displays the various backup status results:
Status
Description
Sucess
The backup file is successfully created with the given parameters.
Failed
The backup process has failed.
Started
The backup process is started and still in progress. This message usually appears when the backup data is large and you verify the status as soon as you initiate the backup process.
Partial
The backup of the data is partially complete.