Module name: sys

Basic URL: /api/v1/sys/

Get working status of device

---

API URL

​ /api/v1/sys/server_info

Request

​ Method: GET/POST

​ Parameters: NONE

Response

Example:

{
    "result": "ok",
    "data": {
        "addr": "192.168.0.100",
        "port": 443,
        "name": "https://192.168.0.100",
        "persis": "4H 15M 32S",
        "start_time": "2020-05-03 12:10:09",
        "cpu_cores": 2,
        "cpu_payload": 33,
        "mem_used": 124.06,
        "mem_total": 620.00
    }
}

Field	Value	Description
addr	[STRING]	IP address of current device
port	[INT]	Current visit access port of HTTP API requests ( default HTTP: 80, HTTPS: 443)
name	[STRING]	Note: This is a field to be discarded or changed. Current it means the host of you are visiting HTTP API.
persis	[STRING]	The persistent time of device running, format: <hour>H <minute>M <second>S
start_time	[STRING]	start-up time of device，format: Year-Month-Day Hour:Minute:Second
cpu_cores	[INT]	CPU cores of the current device
cpu_payload	[INT]	Current CPU load %
mem_used	[NUM]	Current memory in-using, MB
mem_total	[NUM]	Total memory size, MB

Reset all NDI connections

---

This will disconnect all NDI connections and restart: for NDI Encoder, it means reinitialize NDI Sender; for NDI Decoder, it will disconnect current NDI Source and re-connect.

reset time is about 4-6 seconds, please attention.

API URL

​ /api/v1/sys/reconnect

Request

​ Method: GET/POST

​ Parameters: NONE

Response

Example:

{
    "result": "ok"
}

If execute successfully, it will return the message of result = "ok", or please refer to 1.3 for error message descriptions.

Reboot device

---

This operation will control device reboot.

call this API, HTTP request will return immediately, but the real reboot action of device will start in 3s after API executed successfully, the whole reboot process last about 20s. Because the network of device usually use DHCP to obtain address, and the actual DHCP obtain time is depend on the actual network status, so, the expected device visit time will >= 30s.

You will not allowed to request any HTTP API until the device finished rebooting.

Please pay attention: Your security credential (Session ID and Authorization Token) will be invalidated after rebooting, you must re-authorize HTTP API by using the method which shown in chapter 2.

API URL

​ /api/v1/sys/reboot

Request

​ Method: GET/POST

​ Parameters: NONE

Response

Example:

{
    "result": "ok"
}

If execute successfully, it will return the message of result = "ok", or please refer to 1.3 for error message descriptions.

Restore factory setting

---

This operation will restore NDI device to factory default setting. The affected setting include:

• The method to get the network address will be restored to DHCP;
• The network’s Failsafe address will be restored to the factory default ( 192.168.100.168, or 192.168.1.168, depending on different devices, please refer to the product instruction manual) ;
• NDI group will be restored to default (public)；
• NDI device name will be restored to the format of "\<PRODUCT_TYPE>-\<SERIAL-NUMBER>" ;
• NDI channel name will be restored to the factory default name ( Usually Channel-1, but please subject to actual product) ;
• The type of NDI connection will be restored to default (TCP)；
• NDI decoder’s current decoding source and preset will be cleared, the color of Preset 0 (Blank) will to be restored to default (black) ;
• All users will to be cleared, admin user will restore to the default password.

Call this API, HTTP will return immediately, the real reboot action of device will start in 3s after API executed successfully, the reboot action and impact are the same as described in 10.3

API URL

​ /api/v1/sys/restore

Request

​ Method: GET/POST

​ Parameters: NONE

Response

Example:

{
    "result": "ok"
}

If execute successfully, it will return the message of result = "ok", or please refer to 1.3 for error message descriptions.