POST /system/backup/create
FROM API REVISION 4.0
This resource is used to create a new backup file on the device or on an external USB storage.
On the device it will be created under the /backup folder.
The file created will have a name that is a combination of the user's custom filename, the timestamp of the device, and the .ecybackup extension.
A reponse 400 Bad Request can be recovered if the USB key is targeted but not present.
When this request is sent, in the body response, a job ID will be returned.
This job id is the reference for the file creation progress. See Jobs for more details.
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.
Object Name: BackupCreate
| Property Name | Type | Description | Method |
|---|---|---|---|
| JobId | String | This is the ID of the jobs where you can follow the process, or cancel the discovery. |
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 |
| FileName | String | This is the custom name of the file that will be happened to the TimeStamp. | POST |
| Target | String | This is the name of the target where the file will be created. Device or UsbKey |
POST |
Url Example: https://0.0.0.0/api/rest/v1/system/backup/create
{
"target": "UsbKey",
"fileName": "GYM24",
"dataTypes": [
"NETWORK_CONFIGURATION",
"BACNET_CONFIGURATION",
"USER_MANAGEMENT",
"TIMEZONE",
"WEB_SERVER_CONFIGURATION"
],
"envysionProjects": [
"SpaceUtilization",
"nLightExplorer",
"XpressENVYSION"
]
}
Url Example: https://0.0.0.0/api/rest/v1/system/backup/create
<?xml version="1.0" encoding="utf-8"?>
<Backup>
<Target>UsbKey</Target>
<FileName>GYM24</FileName>
<DatatTypes>
<DatatType>NETWORK_CONFIGURATION</DatatType>
<DatatType>BACNET_CONFIGURATION</DatatType>
<DatatType>USER_MANAGEMENT</DatatType>
<DatatType>TIMEZONE</DatatType>
<DatatType>WEB_SERVER_CONFIGURATION</DatatType>
</DatatTypes>
<EnvysionProjects>
<EnvysionProject>SpaceUtilization</EnvysionProject>
<EnvysionProject>nLightExplorer</EnvysionProject>
<EnvysionProject>XpressENVYSION</EnvysionProject>
</EnvysionProjects>
</Backup>
Url Example: https://0.0.0.0/api/rest/v1/system/backup/create
{
"jobId": "cd46a966-2589-43e9-b95d-500f5898b12f"
}
Url Example: https://0.0.0.0/api/rest/v1/system/backup/create
<?xml version="1.0" encoding="utf-8"?>
<BackupCreate>
<JobId>79ebedb0-c754-4e0b-8066-e4db0a0b2bde</JobId>
</BackupCreate>