Full INI File

The /files/ini URL provides the ability to upload or download an ini configuration file. Uploading of an ini file triggers device reset to activate the new configuration. Use /files/ini/incremental (see Incremental INI File) to apply a partial configuration that doesn’t require device reset.

URL

/api/v1/files/ini

HTTP Method

GET, PUT

HTTP Responses

■

200 OK

■

400 Bad request  - provided ini file is incorrect.

■

409 Conflict – ini file can’t be loaded due to the current device state (e.g. synchronization with the redundant device is in progress).

Examples

Example 1:

■

Request:

GET /api/v1/files/ini HTTP/1.1
Host: 10.4.219.229  

■

Request:

HTTP/1.1 200 OK
Content-Type: application/octet-stream
<INI file>

Example 2:

■

Request:

PUT /api/v1/files/ini HTTP/1.1
Host: 10.4.219.229
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
 
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="ini.txt"
Content-Type: application/octet-stream
 
<INI File>
------WebKitFormBoundary7MA4YWxkTrZu0gW--  

■

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "description": "Device will reset now to activate new configuration"
} 

or

HTTP/1.1 409 Conflict
Content-Type: application/json
{
    "description": "Device is currently performing HA synchronization"
}