Restore Web Service
@See Backup and Restore
Overview
These web services can be used before the installation of the Registry has been completed. A restore can not be run if the FMR is already installed, or if a previous restore has been initiated.
The restore API is available from FMR v11.3.0 and later.
Restore API
| Entry Point | /ws/secure/settings/restoreFromBackup |
| Access | Public (pre-installed version only) |
| Http Method | POST |
| POST Content | Path to restore folder or zip file on local file system |
| Response Format | json |
| Response Statuses | 200 OK 500 Error
|
The response to a restore request is a HTTP 200 status if the restore file or folder is found and accepted as valid. The restore process is run in the background (asynchronously). To check the progress of the restore request, the restoreStatus API must be used.
Restore Status
| Entry Point | /ws/secure/settings/restoreStatus |
| Access | Public (pre-installed version only) |
| Http Method | GET |
| Response Format | json |
| Response Statuses | 200 OK 500 Error
|
Response
{
Start : number,
End : number,
Status : string
}
The response JSON provides the time the restore process was started (EPOCH time). The End time is only provided if the restore process is complete. The Status provides the current state of the restore, the Status updates frequently, multiple requests to the restore status service will result in the Status changing over time.
