POST /system/backup/targets/{target}/files/{fileName}/restore
FROM API REVISION 4.0
This action will execute the restore of the current selected backup file.
The value(s) to be recovered from the file can be filtered on the body request.
There is an option to precise if the file need to be deleted after the it has been recovered.
On a success, the device return a status 200 and will reboot after.
If there is an error, the device can return 409 Conflict, 400 Bad Request.
XML is currently not working.
It will be fixed in the next revision (7.0)
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
The Content-Length entity-header field indicates the size of the entity-body.
This is where that backup file is located.
This is the backup file name.
Object Name: Backup
| Property Name | Type | Description | Method |
|---|---|---|---|
| DataTypes | Array <String> |
This property contains all the datatype included in the file. This is all the available properties : - TIMEZONE : This contains the current time zone settings of the device. - WEB_SERVER_CONFIGURATION : This contains the Web Server HTTP & HTTPS settings. - WEATHER : This contains the weather service city configuration and activation. - NETWORK_CONFIGURATION : This contains all the IP network configuration (Ethernet/Wi-Fi) of the device. - USER_MANAGEMENT : This contains the users database & the radius server settings. - MODULES_FIRMWARES : This contains all the IO & expansion modules firmware files present in the device. - CERTIFICATE : This contains the web server certificates. - HOSTNAME : This contains the Hostname of the device. - GFX : This contains the EC-gfxProgram file and the BACnet objects. This will include the BACnet mapping parameters. - BACNET_CONFIGURATION : This contains the BACnet ports configuration and the BACnet Device ID of the device. - PERSISTENCY : This contains the persistency of BACnet objects values and EC-gfxProgram blocks. - TRENDLOG : This contains the BACnet trend logs data of the device. - OPENADR : This contains the Open ADR configuration. |
GET POST |
| EnvysionProjects | Array <String> |
This property contains all the envysion project name included in the file. All the Envysion project available can be recovered on /system/backup url. |
GET POST |
| DeleteAfter | Boolean | This property is used to indicate if we want to delete the file after the recovery. | POST |
Url Example: https://0.0.0.0/api/rest/v1/system/backup/targets/usbkey/files/GYM24-20180720_095032/restore
{
"dataTypes": [
"NETWORK_CONFIGURATION "
],
"envysionProjects": [
"SpaceUtilization"
],
"deleteAfter": false
}
Url Example: https://0.0.0.0/api/rest/v1/system/backup/targets/usbkey/files/GYM24-20180720_095032/restore
<?xml version="1.0" encoding="utf-8"?>
<Backup>
<DeleteAfter>true</DeleteAfter>
<DatatTypes>
<DatatType>NETWORK_CONFIGURATION</DatatType>
</DatatTypes>
<EnvysionProjects>
<EnvysionProject>SpaceUtilization</EnvysionProject>
</EnvysionProjects>
</Backup>