GET /system/backup/targets/{target}/files/{fileName}/
FROM API REVISION 4.0
This resource will display all the information about the selected backup file.
This is a preview mode.
This can take a few seconds to get the response.
The fileName is the name of the backup file without the extension.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
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.
This is where that backup file is located.
This is the backup file name.
Object Name: File
| Property Name | Type | Description | Method |
|---|---|---|---|
| Compatibility | String | This is to indicate via a status, if this backup is compatible with the current device. If there is an error the backup can't be recovered. If there is a warning the backup can be recovered. This is all the possible compatibilityLevel : - OK - WARNING_MISSMATCH_MODELNAME - WARNING_MISSMATCH_FIRMWARE_NEWER - ERROR_MISSMATCH_FIPS_MODE - ERROR_MISSMATCH_FIRMWARE_OLDER - ERROR_NULL_INPUT |
GET |
| 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 |
| IsFips | Boolean | This property indicate if the current file was made on a FIPS device. If the Backup file is FIPS, the data inside are encoded and can't be recovered on a device non FIPS. | GET |
| ReadStatus | String | This is the current status of the backup file. If there is an issue on the file or the file is corrupted, the status will indicate it. Here is the possible values : - OK : Backup file is ready to process or the backup file is created. - KO : The backup can't be created. - EMPTY_TARGET_FIRMWARE : The firmware target is empty. - EMPTY_MODEL_NAME : The Model name is empty. - INCOMPATIBLE_BACKUP : The backup is incompatible (FIPS) - UNABLE_TO_CREATE_TMP_DIR : Unable to create temp directory. - UNABLE_TO_CREATE_TAR : Tar file can't be created. - UNABLE_TO_EXTRACT_TAR : Tar file can't be extracted. - UNABLE_TO_REMOVE_TMP_DIR : Unable to remove the temp directory. - UNABLE_TO_REMOVE_BACKUP_FILE : The backup file can't be removed. - UNABLE_TO_SELF_ASSIGN : System not ready to create the backup file. - COPY_FAILED : The backup copy failed. - BACKUP_DIRECTORY_ALREADY_EXIST : A backup with the same name already exists. - MISSING_TIMEZONE : The timezone is missing. - PARSING_ERROR : The file can't be parsed. - PARSE_DATATYPES_ERROR : The datatypes can't be parsed. - PARSE_ENVYSION_ERROR : The envysion project can't be parsed. - PARSE_BOOLEANS_ERROR : Boolean value can't be parsed. - PARSE_FLOATS_ERROR : Float value can't be parsed. - PARSE_INTS_ERROR : Ints value can't be parsed. - PARSE_LONGS_ERROR : Longs value can't be parsed. - PARSE_STRINGS_ERROR : String value can't be parsed. - PARSE_PASSWORDS_ERROR : Password parsing error. - PARSE_STRINGSETS_ERROR : String Set value can't be parsed. - PARSE_KEYS_TO_REMOVE_ERROR : Internal error. - MISSMATCH_SIGNATURE : Backup signature not valid. - MISSING_SIGNATURE : Backup signature is missing. - MISSING_TARGET_FIRMWARE : Firmware target is missing. - MISSING_MODEL_NAME : Model name is missing. - MISSING_FIPS : Fips is missing. - UNABLE_TO_SIGN_BACKUP : Unable to sign Backup. - NULL_INPUT : Internal error - UNSUPPORTED_OPERATION : The operation is not supported. - UNSUPPORTED_DATATYPE : Unsupported data type. - TIMEOUT_USB_STORAGE : |
GET |
| RebootRequired | Boolean | This is to indicate if the device need to reboot to restore the backup. | GET |
| ModelName | String | This is the model of the device from where the backup has been created. | GET |
| Path | String | This is the REST API path to access to the file. | GET |
| Name | String | This is the name of the file without the extension. | GET |
| TargetFirmware | String | This is the target from where the backup has been created. | GET |
URL Example: https://0.0.0.0/api/rest/v1/system/backup/targets/device/files/GYM24-20180719_175506
{
"compatibility": "OK",
"readStatus": "OK",
"modelName": "ECY-S1000 Rev 1.0A",
"rebootRequired": true,
"name": "GYM24-20180719_175506",
"targetFirmware": "cloud9-v1.10.18201.493",
"path": "/api/rest/v1/files/backup/tutu-20180719_175506.ecybackup",
"dataTypes": [
"NETWORK_CONFIGURATION"
],
"envysionProjects": [
"SpaceUtilization",
"ENVYSIONwidgets"
],
"isFips": false
}
URL Example: https://0.0.0.0/api/rest/v1/system/backup/targets/device/files/GYM24-20180719_175506
<?xml version="1.0" encoding="utf-8"?>
<File>
<Compatibility>OK</Compatibility>
<DataTypes>
<DataType>NETWORK_CONFIGURATION</DataType>
</DataTypes>
<EnvysionProjects>
<EnvysionProject>SpaceUtilization</EnvysionProject>
<EnvysionProject>ENVYSIONwidgets</EnvysionProject>
</EnvysionProjects>
<IsFips>false</IsFips>
<ReadStatus>OK</ReadStatus>
<RebootRequired>true</RebootRequired>
<ModelName>ECY-S1000 Rev 1.0A</ModelName>
<Path>
/api/rest/v1/files/backup/tutu-20180719_175506.ecybackup
</Path>
<Name>GYM24-20180719_175506</Name>
<TargetFirmware>cloud9-v1.10.18201.493</TargetFirmware>
</File>