To work with the server Api is added.

Here is how to work with Api:

IP:PORT/TYPE/NAME/BIND/CMD?PARAM=VALUE

IP - address of the web-interface of your server
PORT - port where the web-interface works
TYPE - way of calling. The following ways are possible:
- HTML - calling as a web-page
- JSON - calling JSON packet
- PLAIN - using API
NAME - name of the page to call to form an answer
BIND - command to request/receive information
The following commands can be used:
Bind to call SystemMenu has the following architecture.
.../systemmenu/... the following parameters are available inside systemmenu:
- get buildversion .../systemmenu/buildversion/get - get version value.
- get buildnumber .../systemmenu/buildnumber /get - get value of the version number.
- get builddate .../systemmenu/builddate/get - get value of the version date.
- get buildtime .../systemmenu/buildtime/get - get time of the version.
- get hwid .../systemmenu/hwid/get - get HWID of a device.
- get ip .../systemmenu/ip/get - get address of a device.

https://127.0.0.1:8443/plan/api/systemmenu/buildversion/get

Bind to call Server has the following architecture.
.../server/... the following parameters are available inside server:
- get name ...systemmenu/server/name/get - get server name
- get os ...systemmenu/server/os/get - get operation system where a server is launched.
- get family ..systemmenu./server/family/get - get
- get model ...systemmenu/server/model/get - get

Bind to call Update has the following architecture.
.../update/... the following parameters are available inside update:
- get host ...systemmenu/update/host/get - get host for update
- set host ...systemmenu/update/host/set? - set host from where the update is to be done
- get port ...systemmenu/update/port/get - get a port from where the update is to be done
- set port ...systemmenu/update/port/set? - get a port from where the update is to be done
- get enabled ...systemmenu/update/enabled/get - get
- set enabled ...systemmenu/update/enabled/set? - set
- set start ...systemmenu/update/start/set? - set

Bind to call log has the following architecture.
.../log/... the following parameters are available inside log:
- get host ...systemmenu/log/host/get - get host to get log
- set host ...systemmenu/log/host/set? -set host to get log
- get port ...systemmenu/log/port/get - get port to get log
- set port ...systemmenu/log/port/set? - set port to get log
- get enabled ...systemmenu/log/enabled/get - get


Bind to call level has the following architecture (log is insertion to level).
.../level/... the following parameters are available inside level:
- get wmi ... systemmenu/log/level/wmi/get
- set wmi ...systemmenu/log/level/wmi/set?
- get db ...systemmenu/log/level/db/get
- set db ...systemmenu/log/level/db/set?
- get script ...systemmenu/log/level/script/get
- set script ...systemmenu/log/level/script/set?

Bind to call dir has the following architecture.
.../dir/... the following parameters are available inside dir:
- get doc ...systemmenu/dir/doc/get - get location of document folder.
- get res ...systemmenu/dir/res/get - get location of resouce folder
- get db ...systemmenu/dir/db/get - get location of database folder
- get logs ...systemmenu/dir/logs/get - get location of log folder.

Bind to call devices has the following architecture.
.../devices/device/... the following parameters are available inside devices:
- get host .../devices/device/host/get - get equipment address
- set host .../devices/device/host/set? - set equipment address
- get port .../devices/device/port/get - get equipment port
- set port .../devices/device/port/set? - set equipment port
- get login .../devices/device/login/get - get login
- get pwd .../devices/device/pwd/get - get password
- get param .../devices/device/param/get - get equipment parameters
- get online .../devices/device/online/get - get equipment state
- get bg .../devices/device/bg/get - get ...
- get logtag .../devices/device/logtag/get - get
- get logvevel .../devices/device/loglevel/get - get the current state of log level
- set loglevel .../devices/device/loglevel/set? - set state of log level
- get channels .../devices/device/channels/get - get equipment commands
- get tags .../devices/device/tags/get - get equipment feedback
For example:
Set the log level https://127.0.0.1:8443/html/devices/devices/device/loglevel/set?name=KNX_BAOS_Server&value=0


Bind to call licence has the following architecture
..../licence/get - get


Bind to call panels has the following architecture
.../panels/... the following parameter is available inside panels:
- set kick .../panels/kick/set? - kick off a connected panel


Bind to call logs has the following architecture
.../logs/... the following parameters are available inside logs:
- get filesizelimit .../logs/filesizelimit/get - get size of file limit
- set filesizelimit .../logs/filesizelimit/set? - set the file size limit
- get dirs .../logs/dirs/get - get directory where log files are stored
- get files .../logs/files/get - get list of files
- get lines .../logs/lines/get - get
- get load .../logs/load/get -
- set clear .../logs/clear/set?


Bind to call storage has the following architecture
.../storage/log/.. the following parameters are available inside storage:
- get sizelimit .../storage/log/sizelimit/get -
- set sizelimit .../storage/log/sizelimit/set? -
- get factor .../storage/log/factor/get -
- set factor .../storage/log/factor/set? -






Bind to call db has the following architecture
.../db/... the following parameters are available inside db:
- get rowlimit .../db/rowlimit/get
- set rowlimit .../db/rowlimit/set?
- get rowrest .../db/rowrest/get
- set rowrest .../db/rowrest/set?
- get sql .../db/sql/get -
- get sql/insertcache .../db/sql/insertcache/get -
- set sql/insertcache .../db/sql/insertcache/set

Is this article helpful for you?