Config#
Methods#
POST#
Edits the configuration of the controller.
POST /api/config
Payload is a JSON object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
string |
Optional. Set the controller’s IP address (management interface) |
|
|
string |
Optional. Set the controller’s subnet mask (management interface) |
|
|
string |
Optional. Set the controller’s gateway address (management interface) |
|
|
boolean |
Optional. Set whether the controller is assigned its IP address automatically by DHCP |
|
|
string |
Optional. Set the primary name server address |
|
|
string |
Optional. Set the secondary name server address |
|
|
integer |
Optional. Set the port opened for HTTP access to the controller’s web server |
|
|
integer |
Optional. Set the port opened for HTTPS access to the controller’s web server |
|
|
integer |
Optional. Set the year of the current date on the controller’s clock |
|
|
integer |
Optional. Set the month of the current date on the controller’s clock (1-12) |
|
|
integer |
Optional. Set the day of the current date on the controller’s clock (1-31) |
|
|
integer |
Optional. Set the hour component of the current time on the controller’s clock (0-23) |
|
|
integer |
Optional. Set the minute component of the current time on the controller’s clock (0-59) |
|
|
integer |
Optional. Set the second component of the current time on the controller’s clock (0-59) |
|
|
boolean |
Optional. Set whether the controller’s hardware watchdog is enabled |
|
|
integer |
Optional. Set the level of verbosity of the controller’s log (1-5) |
|
|
boolean |
Optional. Set whether the controller will send its log to a syslog server |
|
|
string |
Optional. Set the IP address of a third party syslog server |
|
|
boolean |
Optional. Set whether the controller will fetch the current time automatically from an NTP server |
|
|
string |
Optional. Set the IP address of a third party NTP server |
|
If the response status code is 200 (OK), the response body will be a JSON object with a restart
attribute. The value of restart
is boolean. If true
, the controller will reset itself imminently in order to apply the changes.
GET#
Returns information about the queried controller’s configuration.
GET /api/config
Returns a JSON object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
string |
Controller IP address (management interface) |
|
|
string |
Controller subnet mask (management interface) |
|
|
string |
Gateway address (management interface) |
|
|
boolean |
Whether the controller is assigned its IP address automatically by DHCP |
|
|
string |
Primary name server address |
|
|
string |
Secondary name server address |
|
|
integer |
Port opened for HTTP access to the controller’s web server |
|
|
integer |
Port opened for HTTPS access to the controller’s web server |
|
|
integer |
Year of the current date, according to the controller’s clock |
|
|
integer |
Month of the current date, according to the controller’s clock (1-12) |
|
|
integer |
Day of the current date, according to the controller’s clock (1-31) |
|
|
integer |
Hour component of the current time, according to the controller’s clock (0-23) |
|
|
integer |
Minute component of the current time, according to the controller’s clock (0-59) |
|
|
integer |
Second component of the current time, according to the controller’s clock (0-59) |
|
|
boolean |
Whether the controller’s hardware watchdog is enabled |
|
|
integer |
Level of verbosity of the controller’s log (1-5) |
|
|
boolean |
Whether the controller is sending its log to a syslog server |
|
|
string |
IP address of a third party syslog server |
|
|
boolean |
Whether the controller is fetching current time automatically from an NTP server |
|
|
string |
IP address of a third party NTP server |
|