• Authentication
• Device Configuration API
  • general
    • getGet device general configuration.
    • patchUpdate device general configuration.
  • time
    • getGet device time configuration.
    • patchUpdate device time configuration.
  • zoneinfo
    • getGet current timezone information
  • dns
    • getGet device's current DNS settings.
  • route
    • getGet device route configuration.
    • patchUpdate device route configuration.
  • network
    • getGet device route configuration of wan.
  • ethernets
    • getGet ethernet interfaces configuration.
    • getGet ethernet interface configuration.
    • patchUpdate ethernet interface configuration.
  • serials
    • getGet serial interfaces configuration.
    • patchUpdate serial interfaces configuration.
    • getGet serial interface configuration.
    • patchUpdate serial interface configuration.
  • cellulars
    • getGet cellular interfaces configuration.
    • patchUpdate cellular interfaces configuration.
    • getGet cellular interface configuration.
    • patchUpdate cellular configuration.
  • gps
    • getGet gps configuration.
    • patchPatch gps configuration.
  • dhcpservers
    • getGet all DHCP Server configuration
    • patchPatch DHCP Server configuration
    • getGet DHCP Server configuration
    • patchPatch DHCP Server configuration
  • wifi
    • getGet Wi-Fi interfaces configuration.
    • patchUpdate Wi-Fi interface configuration.
    • getGet Wi-Fi interface configuration.
    • patchUpdate Wi-Fi interface configuration.
    • getGet Wi-Fi client networks list
    • postPost a new Wi-Fi client network to list
    • patchUpdate Wi-Fi client network password
    • delDelete Wi-Fi client network
    • getGet Wi-Fi client networks scan results
  • firewall
    • getGet device firewall of port forwarding configurati
    • postPost device firewall of port forwarding configurat
    • patchPatch device firewall of port forwarding configura
    • delDelete device firewall of port forwarding configur
    • getGet device firewall of port forwarding configurati
    • patchPatch device firewall of port forwarding configura
    • delDelete device firewall of port forwarding configur
  • systemtags
    • getGet data of system status tags.
    • getGet data of system storage tags.
    • getGet data of system network usage tags.
  • platform
    • getGet tag list of device app

Documentation Powered by Redocly

Device Configuration APIs (2.1.0)

Download OpenAPI specification:Download

Device Configuration APIs

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

general

Get device general configuration.

Get device general configuration.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/general

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "general",
  • "description": "This is My Thingspro Edge.",
  • "hostName": "Moxa",
  • "modelName": "UC-8112A-ME-T-LX-EU",
  • "serialNumber": "IMOXA1234567",
  • "firmwareVersion": "1.0.0",
  • "biosVersion": "1.0.0S01",
  • "lastRebootTime": "2019-06-27T10:10:16+08:00",
  • "memorySize": 1056120832,
  • "cpu": "ARMv7 Processor rev 2 (v7l)",
  • "disk": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "free": 1905097752,
      • "used": 1138657820,
      • "percent": 35.5,
      • "tags": {

        • "used": "systemDiskUsed",
        • "free": "systemDiskFree",
        • "percent": "systemDiskPercent"

        }

      }

    ]

  }

}

Update device general configuration.

Update device general configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

description

string <= 512 This is My Thingspro Edge.

hostName

string [ 1 .. 64 ] ^[a-zA-Z]([a-zA-Z0-9-]*[a-zA-Z0-9])?(\.[a-zA-... device hostname. - Hostname must be between 1 and 64 octets inclusive. - Each label in the hostname (component separated by ".") must be between 1 and 63 octets inclusive. - Each label must start with an ASCII alphabet character (a-z, A-Z), end with an ASCII alphanumeric character (a-z, A-Z, 0-9), and must contain only ASCII alphanumeric characters or hyphens (a-z, A-Z, 0-9, "-").

Responses

https://127.0.0.1/api/v1/device/general

Request samples

• Payload

Content type

application/json

Example

update device display nameupdate device hostnameupdate device display name

{

• "description": "This is My Thingspro Edge."

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "general",
  • "description": "This is My Thingspro Edge.",
  • "hostName": "MyHost",
  • "modelName": "UC-8112A-ME-T-LX-EU",
  • "serialNumber": "IMOXA1234567",
  • "firmwareVersion": "1.0.0",
  • "biosVersion": "1.0.0S01",
  • "lastRebootTime": "2019-06-27T10:10:16+08:00",
  • "memorySize": 1056120832,
  • "cpu": "ARMv7 Processor rev 2 (v7l)",
  • "disk": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "free": 1905097752,
      • "used": 1138657820,
      • "percent": 35.5,
      • "tags": {

        • "used": "systemDiskUsed",
        • "free": "systemDiskFree",
        • "percent": "systemDiskPercent"

        }

      }

    ]

  }

}

time

Get device time configuration.

Get device time configuration.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/time

Response samples

• 200

Content type

application/json

Example

NtpDisabledNtpTimeServerEnabledNtpTimeServerEnabledAndSyncedNtpGpsEnabledNtpGpsEnabledAndSyncedNtpDisabled

{

• "data": {

  • "type": "time",
  • "lastUpdateTime": "-",
  • "time": "2015-03-26T16:27:48+08:00",
  • "timezone": "Asia/Taipei",
  • "ntp": {

    • "enable": false,
    • "source": "timeserver",
    • "server": "pool.ntp.org",
    • "gpsLongJump": true,
    • "interval": 86400

    }

  }

}

Update device time configuration.

Update device time configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

time	string [ 20 .. 35 ] characters Current system time (format: RFC3339).
timezone	string [ 1 .. 64 ] characters device timezone.
	object

Responses

https://127.0.0.1/api/v1/device/time

Request samples

• Payload

Content type

application/json

Example

update timeupdate timezonesync time from time serversync time by gpsupdate time

{

• "time": "2015-03-26T16:27:48+08:00"

}

Response samples

• 200

Content type

application/json

Example

NtpDisabledNtpTimeServerEnabledNtpTimeServerEnabledAndSyncedNtpGpsEnabledNtpGpsEnabledAndSyncedNtpDisabled

{

• "data": {

  • "type": "time",
  • "lastUpdateTime": "-",
  • "time": "2015-03-26T16:27:48+08:00",
  • "timezone": "Asia/Taipei",
  • "ntp": {

    • "enable": false,
    • "source": "timeserver",
    • "server": "pool.ntp.org",
    • "gpsLongJump": true,
    • "interval": 86400

    }

  }

}

zoneinfo

Get current timezone information

Get current timezone information

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/zoneinfo

Response samples

• 200

Content type

application/json

{

• "data": {

  • "zone": [

    • {

      • "cca2": "AD",
      • "name": "Europe/Andorra",
      • "offset": "+0100"

      },
    • {

      • "cca2": "AE",
      • "name": "Asia/Dubai",
      • "offset": "+0400"

      },
    • {

      • "cca2": "AF",
      • "name": "Asia/Kabul",
      • "offset": "+0430"

      }

    ],
  • "iso3166": [

    • {

      • "cca2": "AD",
      • "name": "Andorra"

      },
    • {

      • "cca2": "AE",
      • "name": "United Arab Emirates"

      },
    • {

      • "cca2": "AF",
      • "name": "Afghanistan"

      }

    ]

  }

}

dns

Get device's current DNS settings.

Get device's current DNS settings.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/dns

Response samples

• 200

Content type

application/json

{

• "data": [

  • "10.128.8.8",
  • "8.8.8.8"

  ]

}

route

Get device route configuration.

Get device route configuration.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/route

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "route",
  • "default": "LAN1",
  • "priorityList": [

    • "LAN1",
    • "Cellular1",
    • "LAN2"

    ]

  }

}

Update device route configuration.

Update device route configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

priorityList

Array of strings[ items [ 2 .. 15 ] characters [A-Za-z0-9_-]+ ]

Responses

https://127.0.0.1/api/v1/device/route

Request samples

• Payload

Content type

application/json

{

• "priorityList": [

  • "LAN2",
  • "Cellular1",
  • "LAN1"

  ]

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "route",
  • "default": "LAN2",
  • "priorityList": [

    • "LAN2",
    • "Cellular1",
    • "LAN1"

    ]

  }

}

network

Get device route configuration of wan.

Get device route configuration of wan.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/network/wan

Response samples

• 200

Content type

application/json

{

• "data": {

  • "name": "eth0",
  • "displayName": "LAN1",
  • "ip": "192.168.3.127",
  • "netmask": "255.255.255.0",
  • "gateway": "192.168.3.254",
  • "dns": [

    • "192.168.3.1"

    ]

  }

}

ethernets

Get ethernet interfaces configuration.

Get ethernet interfaces configuration.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/ethernets

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "type": "ethernets",
    • "id": 1,
    • "displayName": "LAN1",
    • "name": "eth0",
    • "wan": true,
    • "enable": true,
    • "status": "connected",
    • "enableDhcp": false,
    • "ip": "192.168.3.100",
    • "netmask": "255.255.255.0",
    • "subnet": "192.168.3.0",
    • "broadcast": "192.168.3.255",
    • "gateway": "192.168.3.254",
    • "dns": [

      • "8.8.8.8",
      • "4.4.4.4"

      ],
    • "mac": "00:90:e8:12:34:56"

    }

  ],
• "count": 1

}

Get ethernet interface configuration.

Get ethernet interface configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer Example: 1 Ethernet interface id.

Responses

https://127.0.0.1/api/v1/device/ethernets/{id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "ethernets",
  • "id": 1,
  • "displayName": "LAN1",
  • "name": "eth0",
  • "wan": true,
  • "enable": true,
  • "status": "connected",
  • "enableDhcp": false,
  • "ip": "192.168.3.100",
  • "netmask": "255.255.255.0",
  • "subnet": "192.168.3.0",
  • "broadcast": "192.168.3.255",
  • "gateway": "192.168.3.254",
  • "dns": [

    • "8.8.8.8",
    • "4.4.4.4"

    ],
  • "mac": "00:90:e8:12:34:56"

  }

}

Update ethernet interface configuration.

Update ethernet interface configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer Example: 1 Ethernet interface id.

Request Body schema: application/json

One of

id	integer >= 1 Identifier of an Ethernet interface.
enable required	boolean Set interface UP.
enableDhcp required	boolean Enable (true) the dhcp client.
wan required	boolean Define the interface type is WAN (true) or LAN (false)

Responses

https://127.0.0.1/api/v1/device/ethernets/{id}

Request samples

• Payload

Content type

application/json

Example

dhcpstaticdhcp

{

• "enable": true,
• "enableDhcp": true,
• "wan": true

}

Response samples

• 200

Content type

application/json

Example

dhcpstaticdhcp

{

• "data": {

  • "type": "ethernets",
  • "id": 1,
  • "displayName": "LAN1",
  • "name": "eth0",
  • "wan": true,
  • "enable": true,
  • "status": "connected",
  • "enableDhcp": true,
  • "ip": "192.168.3.100",
  • "netmask": "255.255.255.0",
  • "subnet": "192.168.3.0",
  • "broadcast": "192.168.3.255",
  • "gateway": "192.168.3.254",
  • "dns": [

    • "8.8.8.8",
    • "4.4.4.4"

    ],
  • "mac": "00:90:e8:12:34:56"

  }

}

serials

Get serial interfaces configuration.

Get serial interfaces configuration.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/serials

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "type": "serials",
    • "id": 1,
    • "mode": "rs232",
    • "displayName": "P1",
    • "device": "/dev/ttyM0",
    • "baudRate": 9600,
    • "parity": "none",
    • "dataBits": 8,
    • "stopBits": 1,
    • "flowControl": "hardware",
    • "capabilities": {

      • "mode": [

        • "rs232",
        • "rs422",
        • "rs4852w",
        • "rs4854w"

        ],
      • "baudRate": {

        • "special": false,
        • "range": [

          • 300,
          • 600,
          • 1200,
          • 1800,
          • 2400,
          • 4800,
          • 9600,
          • 19200,
          • 38400,
          • 57600,
          • 115200,
          • 230400,
          • 460800,
          • 921600

          ]

        },
      • "parities": [

        • "none",
        • "odd",
        • "even",
        • "space",
        • "mark"

        ],
      • "dataBits": [

        • 5,
        • 6,
        • 7,
        • 8

        ],
      • "stopBits": [

        • 1,
        • 2,
        • 1.5

        ],
      • "flowControl": [

        • "none",
        • "hardware",
        • "software"

        ]

      }

    },
  • {

    • "type": "serials",
    • "id": 2,
    • "mode": "rs422",
    • "displayName": "P2",
    • "device": "/dev/ttyM1",
    • "baudRate": 115200,
    • "parity": "none",
    • "dataBits": 8,
    • "stopBits": 1,
    • "flowControl": "software",
    • "capabilities": {

      • "mode": [

        • "rs232",
        • "rs422",
        • "rs4852w",
        • "rs4854w"

        ],
      • "baudRate": {

        • "special": false,
        • "range": [

          • 300,
          • 600,
          • 1200,
          • 1800,
          • 2400,
          • 4800,
          • 9600,
          • 19200,
          • 38400,
          • 57600,
          • 115200,
          • 230400,
          • 460800,
          • 921600

          ]

        },
      • "parities": [

        • "none",
        • "odd",
        • "even",
        • "space",
        • "mark"

        ],
      • "dataBits": [

        • 5,
        • 6,
        • 7,
        • 8

        ],
      • "stopBits": [

        • 1,
        • 2,
        • 1.5

        ],
      • "flowControl": [

        • "none",
        • "hardware",
        • "software"

        ]

      }

    }

  ],
• "count": 2

}

Update serial interfaces configuration.

Update serial interfaces configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

Array

id	integer Interface id.
mode	string Enum: "rs232" "rs422" "rs4852w" "rs4854w" Serial interface mode.
baudRate	integer baud rate
parity	string parity
dataBits	integer data bits
stopBits	number stop bits
flowControl	string flow control

Responses

https://127.0.0.1/api/v1/device/serials

Request samples

• Payload

Content type

application/json

[

• {

  • "id": 1,
  • "mode": "rs232"

  },
• {

  • "id": 2,
  • "mode": "rs4852w",
  • "baudRate": 19200,
  • "parity": "none",
  • "dataBits": 8,
  • "stopBits": 1,
  • "flowControl": "none"

  }

]

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "type": "serials",
    • "id": 1,
    • "mode": "rs232",
    • "displayName": "P1",
    • "device": "/dev/ttyM0",
    • "baudRate": 9600,
    • "parity": "none",
    • "dataBits": 8,
    • "stopBits": 1,
    • "flowControl": "hardware"

    },
  • {

    • "type": "serials",
    • "id": 2,
    • "mode": "rs4852w",
    • "displayName": "P2",
    • "device": "/dev/ttyM1",
    • "baudRate": 19200,
    • "parity": "none",
    • "dataBits": 8,
    • "stopBits": 1,
    • "flowControl": "none"

    }

  ],
• "count": 2

}

Get serial interface configuration.

Get serial interface configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer Example: 1 Serial interface id.

Responses

https://127.0.0.1/api/v1/device/serials/{id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "serials",
  • "id": 1,
  • "mode": "rs232",
  • "displayName": "P1",
  • "device": "/dev/ttyM0",
  • "baudRate": 9600,
  • "parity": "none",
  • "dataBits": 8,
  • "stopBits": 1,
  • "flowControl": "hardware",
  • "capabilities": {

    • "mode": [

      • "rs232",
      • "rs422",
      • "rs4852w",
      • "rs4854w"

      ],
    • "baudRate": {

      • "special": false,
      • "range": [

        • 300,
        • 600,
        • 1200,
        • 1800,
        • 2400,
        • 4800,
        • 9600,
        • 19200,
        • 38400,
        • 57600,
        • 115200,
        • 230400,
        • 460800,
        • 921600

        ]

      },
    • "parities": [

      • "none",
      • "odd",
      • "even",
      • "space",
      • "mark"

      ],
    • "dataBits": [

      • 5,
      • 6,
      • 7,
      • 8

      ],
    • "stopBits": [

      • 1,
      • 2,
      • 1.5

      ],
    • "flowControl": [

      • "none",
      • "hardware",
      • "software"

      ]

    }

  }

}

Update serial interface configuration.

Update serial interface configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer Example: 1 Serial interface id.

Request Body schema: application/json

id	integer Interface id.
mode	string Enum: "rs232" "rs422" "rs4852w" "rs4854w" Serial interface mode.
baudRate	integer baud rate
parity	string parity
dataBits	integer data bits
stopBits	number stop bits
flowControl	string flow control

Responses

https://127.0.0.1/api/v1/device/serials/{id}

Request samples

• Payload

Content type

application/json

{

• "mode": "rs422",
• "flowControl": "software"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "serial",
  • "id": 1,
  • "mode": "rs422",
  • "displayName": "P1",
  • "device": "/dev/ttyM0",
  • "baudRate": 115200,
  • "parity": "none",
  • "dataBits": 8,
  • "stopBits": 1,
  • "flowControl": "software"

  }

}

cellulars

Get cellular interfaces configuration.

Get cellular interfaces configuration.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/cellulars

Response samples

• 200

Content type

application/json

Example

all cellular informationall cellular information not availableall cellular information

{

• "count": 1,
• "data": [

  • {

    • "currentProfileId": 1,
    • "carrier": "ATT",
    • "ip": "",
    • "tac": "",
    • "type": "cellular",
    • "operatorName": "",
    • "keepalive": {

      • "intervalSec": 60,
      • "enable": true,
      • "targetHost": "8.8.8.8",
      • "reboot": {

        • "enable": true,
        • "intervalMin": 20

        }

      },
    • "capabilities": {

      • "sim": 1,
      • "carriers": [

        • "ATT",
        • "SPRINT"

        ]

      },
    • "id": 1,
    • "gateway": "",
    • "autoDetect": false,
    • "profileTimeout": 120,
    • "esn": "80AF33D7",
    • "imsi": "466977300046885",
    • "status": "ready",
    • "enable": false,
    • "available": true,
    • "dns": [ ],
    • "bid": "",
    • "nid": "",
    • "lac": "11114",
    • "mac": "00:00:11:12:13:14",
    • "imei": "359841080332053",
    • "cellId": "6326",
    • "name": "wwan0",
    • "displayName": "wwan0",
    • "signal": {

      • "rssi": -67,
      • "rsrq": 0,
      • "csq": 16,
      • "ecio": 0

      },
    • "pinRetryRemain": -1,
    • "netmask": "",
    • "profiles": [

      • {

        • "pinCode": "0000",
        • "init": [

          • "sim:1",
          • "carrier:ATT"

          ],
        • "id": 1,
        • "name": "SIM1",
        • "pdpContext": {

          • "static": true,
          • "apn": "internet",
          • "id": 1,
          • "auth": {

            • "protocol": "none",
            • "username": "",
            • "password": ""

            },
          • "type": "ipv4"

          }

        }

      ],
    • "mode": "lte",
    • "iccId": "89886971410730170000"

    }

  ]

}

Update cellular interfaces configuration.

Update cellular interfaces configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

Array

id	integer Interface id.
enable required	boolean Enable Cellular Networking.
autoDetect	boolean Auto detect SIM slot, carrier and APN to create profiles
profileTimeout	integer [ 60 .. 3600 ] Retry timeout in seconds for switch profiles.
	Array of objects (Cellular Profile) [ items ] Profiles for redundancy
	object (Keepalive Settings)

Responses

https://127.0.0.1/api/v1/device/cellulars

Request samples

• Payload

Content type

application/json

Example

patch multiple cellulars settingspatch multiple cellulars settings with auto detectpatch multiple cellulars settings

[

• {

  • "id": 1,
  • "enable": true,
  • "keepalive": {

    • "intervalSec": 60,
    • "enable": true,
    • "targetHost": "8.8.8.8",
    • "reboot": {

      • "enable": true,
      • "intervalMin": 20

      }

    },
  • "autoDetect": false,
  • "profileTimeout": 120,
  • "profiles": [

    • {

      • "pinCode": "0000",
      • "init": [

        • "sim:1",
        • "carrier:ATT"

        ],
      • "name": "SIM1",
      • "pdpContext": {

        • "static": true,
        • "apn": "internet",
        • "id": 1,
        • "auth": {

          • "protocol": "none",
          • "username": "",
          • "password": ""

          },
        • "type": "ipv4"

        }

      }

    ]

  }

]

Response samples

• 200

Content type

application/json

Example

all cellular informationall cellular information not availableall cellular information

{

• "count": 1,
• "data": [

  • {

    • "currentProfileId": 1,
    • "carrier": "ATT",
    • "ip": "",
    • "tac": "",
    • "type": "cellular",
    • "operatorName": "",
    • "keepalive": {

      • "intervalSec": 60,
      • "enable": true,
      • "targetHost": "8.8.8.8",
      • "reboot": {

        • "enable": true,
        • "intervalMin": 20

        }

      },
    • "capabilities": {

      • "sim": 1,
      • "carriers": [

        • "ATT",
        • "SPRINT"

        ]

      },
    • "id": 1,
    • "gateway": "",
    • "autoDetect": false,
    • "profileTimeout": 120,
    • "esn": "80AF33D7",
    • "imsi": "466977300046885",
    • "status": "ready",
    • "enable": false,
    • "available": true,
    • "dns": [ ],
    • "bid": "",
    • "nid": "",
    • "lac": "11114",
    • "mac": "00:00:11:12:13:14",
    • "imei": "359841080332053",
    • "cellId": "6326",
    • "name": "wwan0",
    • "displayName": "wwan0",
    • "signal": {

      • "rssi": -67,
      • "rsrq": 0,
      • "csq": 16,
      • "ecio": 0

      },
    • "pinRetryRemain": -1,
    • "netmask": "",
    • "profiles": [

      • {

        • "pinCode": "0000",
        • "init": [

          • "sim:1",
          • "carrier:ATT"

          ],
        • "id": 1,
        • "name": "SIM1",
        • "pdpContext": {

          • "static": true,
          • "apn": "internet",
          • "id": 1,
          • "auth": {

            • "protocol": "none",
            • "username": "",
            • "password": ""

            },
          • "type": "ipv4"

          }

        }

      ],
    • "mode": "lte",
    • "iccId": "89886971410730170000"

    }

  ]

}

Get cellular interface configuration.

Get cellular interface configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer Cellular interface id.

Responses

https://127.0.0.1/api/v1/device/cellulars/{id}

Response samples

• 200

Content type

application/json

Example

cellular informationcellular information not availablecellular information

{

• "currentProfileId": 1,
• "carrier": "ATT",
• "ip": "",
• "tac": "",
• "type": "cellular",
• "operatorName": "",
• "keepalive": {

  • "intervalSec": 60,
  • "enable": true,
  • "targetHost": "8.8.8.8",
  • "reboot": {

    • "enable": true,
    • "intervalMin": 20

    }

  },
• "capabilities": {

  • "sim": 1,
  • "carriers": [

    • "ATT",
    • "SPRINT"

    ]

  },
• "id": 1,
• "gateway": "",
• "autoDetect": false,
• "profileTimeout": 120,
• "esn": "80AF33D7",
• "imsi": "466977300046885",
• "status": "ready",
• "enable": false,
• "available": true,
• "dns": [ ],
• "bid": "",
• "nid": "",
• "lac": "11114",
• "mac": "00:00:11:12:13:14",
• "imei": "359841080332053",
• "cellId": "6326",
• "name": "wwan0",
• "displayName": "wwan0",
• "signal": {

  • "rssi": -67,
  • "rsrq": 0,
  • "csq": 16,
  • "ecio": 0

  },
• "pinRetryRemain": -1,
• "netmask": "",
• "profiles": [

  • {

    • "pinCode": "0000",
    • "init": [

      • "sim:1",
      • "carrier:ATT"

      ],
    • "id": 1,
    • "name": "SIM1",
    • "pdpContext": {

      • "static": true,
      • "apn": "internet",
      • "id": 1,
      • "auth": {

        • "protocol": "none",
        • "username": "",
        • "password": ""

        },
      • "type": "ipv4"

      }

    }

  ],
• "mode": "lte",
• "iccId": "89886971410730170000"

}

Update cellular configuration.

Update cellular configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer Cellular interface id.

Request Body schema: application/json

enable required	boolean Enable Cellular Networking.
autoDetect	boolean Auto detect SIM slot, carrier and APN to create profiles
profileTimeout	integer [ 60 .. 3600 ] Retry timeout in seconds for switch profiles.
	Array of objects (Cellular Profile) [ items ] Profiles for redundancy
	object (Keepalive Settings)

Responses

https://127.0.0.1/api/v1/device/cellulars/{id}

Request samples

• Payload

Content type

application/json

Example

patch a cellular settingspatch a cellular settings with auto detectpatch a cellular settings

{

• "enable": true,
• "keepalive": {

  • "intervalSec": 60,
  • "enable": true,
  • "targetHost": "8.8.8.8",
  • "reboot": {

    • "enable": true,
    • "intervalMin": 20

    }

  },
• "autoDetect": false,
• "profileTimeout": 120,
• "profiles": [

  • {

    • "pinCode": "0000",
    • "init": [

      • "sim:1",
      • "carrier:ATT"

      ],
    • "name": "SIM1",
    • "pdpContext": {

      • "static": true,
      • "apn": "internet",
      • "id": 1,
      • "auth": {

        • "protocol": "none",
        • "username": "",
        • "password": ""

        },
      • "type": "ipv4"

      }

    }

  ]

}

Response samples

• 200

Content type

application/json

Example

cellular informationcellular information not availablecellular information

{

• "currentProfileId": 1,
• "carrier": "ATT",
• "ip": "",
• "tac": "",
• "type": "cellular",
• "operatorName": "",
• "keepalive": {

  • "intervalSec": 60,
  • "enable": true,
  • "targetHost": "8.8.8.8",
  • "reboot": {

    • "enable": true,
    • "intervalMin": 20

    }

  },
• "capabilities": {

  • "sim": 1,
  • "carriers": [

    • "ATT",
    • "SPRINT"

    ]

  },
• "id": 1,
• "gateway": "",
• "autoDetect": false,
• "profileTimeout": 120,
• "esn": "80AF33D7",
• "imsi": "466977300046885",
• "status": "ready",
• "enable": false,
• "available": true,
• "dns": [ ],
• "bid": "",
• "nid": "",
• "lac": "11114",
• "mac": "00:00:11:12:13:14",
• "imei": "359841080332053",
• "cellId": "6326",
• "name": "wwan0",
• "displayName": "wwan0",
• "signal": {

  • "rssi": -67,
  • "rsrq": 0,
  • "csq": 16,
  • "ecio": 0

  },
• "pinRetryRemain": -1,
• "netmask": "",
• "profiles": [

  • {

    • "pinCode": "0000",
    • "init": [

      • "sim:1",
      • "carrier:ATT"

      ],
    • "id": 1,
    • "name": "SIM1",
    • "pdpContext": {

      • "static": true,
      • "apn": "internet",
      • "id": 1,
      • "auth": {

        • "protocol": "none",
        • "username": "",
        • "password": ""

        },
      • "type": "ipv4"

      }

    }

  ],
• "mode": "lte",
• "iccId": "89886971410730170000"

}

gps

Get gps configuration.

Get gps configuration.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/gps

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "gps",
  • "mode": "manual",
  • "interface": "",
  • "location": {

    • "lat": 23.5,
    • "lng": 121.2

    },
  • "capabilities": {

    • "interface": [

      • "/dev/ttyUSB0",
      • "/dev/ttyUSB1"

      ]

    }

  }

}

Patch gps configuration.

Patch gps configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

mode required	string
	object (GpsLocation) Location information, with latitude and longitude data.

Responses

https://127.0.0.1/api/v1/device/gps

Request samples

• Payload

Content type

application/json

Example

set manual mode with lat/lng valueset auto mode with interfaceset manual mode with lat/lng value

{

• "mode": "manual",
• "location": {

  • "lat": 23.5,
  • "lng": 121.2

  }

}

Response samples

• 200

Content type

application/json

Example

manualautomanual

{

• "data": {

  • "type": "gps",
  • "mode": "manual",
  • "interface": "",
  • "location": {

    • "lat": 23.5,
    • "lng": 121.2

    }

  }

}

dhcpservers

Get all DHCP Server configuration

Get all DHCP Server configuration

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/dhcpservers

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "type": "dhcpservers",
    • "id": 1,
    • "status": true,
    • "available": true,
    • "name": "eth0",
    • "displayName": "LAN1",
    • "enable": true,
    • "startIp": "192.168.3.100",
    • "endIp": "192.168.3.200",
    • "netmask": "255.255.255.0",
    • "domainNameServers": [

      • "8.8.8.8"

      ],
    • "domainName": "example.com",
    • "leaseTime": 2592000

    },
  • {

    • "type": "dhcpservers",
    • "id": 2,
    • "status": true,
    • "available": true,
    • "name": "eth1",
    • "displayName": "LAN2",
    • "enable": true,
    • "startIp": "192.168.4.100",
    • "endIp": "192.168.4.200",
    • "netmask": "255.255.255.0",
    • "domainNameServers": [

      • "8.8.8.8"

      ],
    • "domainName": "example.com",
    • "leaseTime": 2592000

    }

  ],
• "count": 2

}

Patch DHCP Server configuration

Patch DHCP Server configuration

Authorizations:

bearerAuth

Request Body schema: application/json

Array

id required	integer >= 1 Identifier of a DHCP Server
enable	boolean Enable (true) or disable (false) DHCP Server
startIp	string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\... Range IP start
endIp	string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\... Range IP end
netmask	string^(?:(?:254|252|248|240|224|192|128)\.0\.0\.0|... Netmask of DHCP Server
domainNameServers	Array of strings Domain name servers
domainName	string [ 2 .. 253 ] characters (?=^.{2,253}$)(?:^(?!\.|-)[a-zA-Z0-9\-]{0,62}... Domain name, empty is allowed
leaseTime	integer [ 60 .. 2592000 ] Lease time of DHCP pool

Responses

https://127.0.0.1/api/v1/device/dhcpservers

Request samples

• Payload

Content type

application/json

Example

Single DHCP Server Configuration with Full SettingMultiple DHCP Servers Configuration with Full SettingSingle DHCP Server Configuration with Partial SettingMultiple DHCP Servers Configuration with Partial SettingSingle DHCP Server Configuration with Full Setting

[

• {

  • "id": 1,
  • "enable": true,
  • "startIp": "192.168.3.100",
  • "endIp": "192.168.3.200",
  • "netmask": "255.255.255.0",
  • "domainNameServers": [

    • "8.8.8.8"

    ],
  • "domainName": "example.com",
  • "leaseTime": 2592000

  }

]

Response samples

• 200

Content type

application/json

Example

Single DHCP Server Configuration with Full SettingMultiple DHCP Servers Configuration with Full SettingSingle DHCP Server Configuration with Partial SettingMultiple DHCP Servers Configuration with Partial SettingSingle DHCP Server Configuration with Full Setting

{

• "data": [

  • {

    • "type": "dhcpservers",
    • "id": 1,
    • "status": true,
    • "available": true,
    • "enable": true,
    • "name": "eth0",
    • "displayName": "LAN1",
    • "startIp": "192.168.3.100",
    • "endIp": "192.168.3.200",
    • "netmask": "255.255.255.0",
    • "domainNameServers": [

      • "8.8.8.8"

      ],
    • "domainName": "example.com",
    • "leaseTime": 2592000

    }

  ],
• "count": 1

}

Get DHCP Server configuration

Get DHCP Server configuration

Authorizations:

bearerAuth

path Parameters

id required

integer DHCP Server ID

Responses

https://127.0.0.1/api/v1/device/dhcpservers/{id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "type": "dhcpservers",
  • "id": 1,
  • "status": true,
  • "available": true,
  • "name": "eth0",
  • "displayName": "LAN1",
  • "enable": true,
  • "startIp": "192.168.3.100",
  • "endIp": "192.168.3.200",
  • "netmask": "255.255.255.0",
  • "domainNameServers": [

    • "8.8.8.8"

    ],
  • "domainName": "example.com",
  • "leaseTime": 2592000

  }

}

Patch DHCP Server configuration

Patch DHCP Server configuration

Authorizations:

bearerAuth

path Parameters

id required

integer DHCP Server ID

Request Body schema: application/json

id required	integer >= 1 Identifier of a DHCP Server
enable	boolean Enable (true) or disable (false) DHCP Server
startIp	string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\... Range IP start
endIp	string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\... Range IP end
netmask	string^(?:(?:254|252|248|240|224|192|128)\.0\.0\.0|... Netmask of DHCP Server
domainNameServers	Array of strings Domain name servers
domainName	string [ 2 .. 253 ] characters (?=^.{2,253}$)(?:^(?!\.|-)[a-zA-Z0-9\-]{0,62}... Domain name, empty is allowed
leaseTime	integer [ 60 .. 2592000 ] Lease time of DHCP pool

Responses

https://127.0.0.1/api/v1/device/dhcpservers/{id}

Request samples

• Payload

Content type

application/json

Example

DHCP Server Configuration with Full SettingDHCP Server Configuration with Partial SettingDHCP Server Configuration with Full Setting

{

• "id": 1,
• "enable": true,
• "startIp": "192.168.3.100",
• "endIp": "192.168.3.200",
• "netmask": "255.255.255.0",
• "domainNameServers": [

  • "8.8.8.8"

  ],
• "domainName": "example.com",
• "leaseTime": 2592000

}

Response samples

• 200

Content type

application/json

Example

DHCP Server Configuration with Full SettingDHCP Server Configuration with Partial SettingDHCP Server Configuration with Full Setting

{

• "data": {

  • "type": "dhcpservers",
  • "id": 1,
  • "status": true,
  • "available": true,
  • "name": "eth0",
  • "displayName": "LAN1",
  • "enable": true,
  • "startIp": "192.168.3.100",
  • "endIp": "192.168.3.200",
  • "netmask": "255.255.255.0",
  • "domainNameServers": [

    • "8.8.8.8"

    ],
  • "domainName": "example.com",
  • "leaseTime": 2592000

  }

}

wifi

Get Wi-Fi interfaces configuration.

Get Wi-Fi interfaces configuration.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/wifi

Response samples

• 200

Content type

application/json

Example

APModeClientModeAPMode

{

• "data": [

  • {

    • "type": "wifi",
    • "id": 1,
    • "name": "wlan0",
    • "displayName": "Wi-Fi1",
    • "available": true,
    • "mode": "ap",
    • "enable": false,
    • "status": false,
    • "capabilities": {

      • "mode": [

        • "ap",
        • "client"

        ],
      • "band": [

        • "band24",
        • "band50"

        ]

      },
    • "regions": [

      • {

        • "name": "North America",
        • "countryCode": "US",
        • "band24": [

          • 1,
          • 2,
          • 3,
          • 4,
          • 5,
          • 6,
          • 7,
          • 8,
          • 9,
          • 10,
          • 11

          ],
        • "band50": [

          • 36,
          • 38,
          • 40,
          • 42,
          • 44,
          • 46,
          • 48,
          • 149,
          • 153,
          • 157,
          • 161,
          • 165

          ]

        },
      • {

        • "name": "Europe",
        • "countryCode": "GB",
        • "band24": [

          • 1,
          • 2,
          • 3,
          • 4,
          • 5,
          • 6,
          • 7,
          • 8,
          • 9,
          • 10,
          • 11,
          • 12,
          • 13

          ],
        • "band50": [

          • 36,
          • 38,
          • 40,
          • 42,
          • 44,
          • 46,
          • 48

          ]

        },
      • {

        • "name": "Taiwan",
        • "countryCode": "TW",
        • "band24": [

          • 1,
          • 2,
          • 3,
          • 4,
          • 5,
          • 6,
          • 7,
          • 8,
          • 9,
          • 10,
          • 11,
          • 12,
          • 13

          ],
        • "band50": [

          • 34,
          • 36,
          • 38,
          • 40,
          • 42,
          • 44,
          • 46,
          • 48,
          • 149,
          • 153,
          • 157,
          • 161,
          • 165

          ]

        }

      ],
    • "ap": {

      • "band": "band24",
      • "broadcastSsid": true,
      • "ssid": "moxa-test-ap-1",
      • "security": {

        • "mode": "wpa2-personal",
        • "encryption": "aes",
        • "password": ""

        },
      • "channel": 6,
      • "region": "TW",
      • "clients": [ ]

      }

    }

  ],
• "count": 1

}

Update Wi-Fi interface configuration.

Update Wi-Fi interface configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

	Array of objects[ items ]
count	integer Array length.

Responses

https://127.0.0.1/api/v1/device/wifi

Request samples

• Payload

Content type

application/json

Example

APModeClientModeAPMode

[

• {

  • "type": "wifi",
  • "id": 1,
  • "name": "wlan0",
  • "displayName": "Wi-Fi1",
  • "mode": "ap",
  • "enable": true,
  • "ap": {

    • "band": "band24",
    • "broadcastSsid": true,
    • "ssid": "moxa-test-ap-1",
    • "security": {

      • "mode": "personal",
      • "encryption": "aes",
      • "password": ""

      },
    • "channel": 6,
    • "region": "US"

    }

  }

]

Response samples

• 200

Content type

application/json

Example

APModeClientModeAPMode

{

• "data": [

  • {

    • "type": "wifi",
    • "id": 1,
    • "name": "wlan0",
    • "displayName": "Wi-Fi1",
    • "mode": "ap",
    • "enable": true,
    • "ap": {

      • "band": "band24",
      • "broadcastSsid": true,
      • "ssid": "moxa-test-ap-1",
      • "security": {

        • "mode": "wpa2",
        • "encryption": "aes",
        • "password": ""

        },
      • "channel": 11,
      • "region": "US"

      }

    }

  ],
• "count": 1

}

Get Wi-Fi interface configuration.

Get Wi-Fi interface configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer Interface id.

Responses

https://127.0.0.1/api/v1/device/wifi/{id}

Response samples

• 200

Content type

application/json

Example

APModeClientModeAPMode

{

• "data": {

  • "type": "wifi",
  • "id": 1,
  • "name": "wlan0",
  • "displayName": "Wi-Fi1",
  • "available": true,
  • "mode": "ap",
  • "enable": false,
  • "status": false,
  • "capabilities": {

    • "mode": [

      • "ap",
      • "client"

      ],
    • "band": [

      • "band24",
      • "band50"

      ]

    },
  • "regions": [

    • {

      • "name": "North America",
      • "countryCode": "US",
      • "band24": [

        • 1,
        • 2,
        • 3,
        • 4,
        • 5,
        • 6,
        • 7,
        • 8,
        • 9,
        • 10,
        • 11

        ],
      • "band50": [

        • 36,
        • 38,
        • 40,
        • 42,
        • 44,
        • 46,
        • 48,
        • 149,
        • 153,
        • 157,
        • 161,
        • 165

        ]

      },
    • {

      • "name": "Europe",
      • "countryCode": "GB",
      • "band24": [

        • 1,
        • 2,
        • 3,
        • 4,
        • 5,
        • 6,
        • 7,
        • 8,
        • 9,
        • 10,
        • 11,
        • 12,
        • 13

        ],
      • "band50": [

        • 36,
        • 38,
        • 40,
        • 42,
        • 44,
        • 46,
        • 48

        ]

      },
    • {

      • "name": "Taiwan",
      • "countryCode": "TW",
      • "band24": [

        • 1,
        • 2,
        • 3,
        • 4,
        • 5,
        • 6,
        • 7,
        • 8,
        • 9,
        • 10,
        • 11,
        • 12,
        • 13

        ],
      • "band50": [

        • 34,
        • 36,
        • 38,
        • 40,
        • 42,
        • 44,
        • 46,
        • 48,
        • 149,
        • 153,
        • 157,
        • 161,
        • 165

        ]

      }

    ],
  • "ap": {

    • "band": "band24",
    • "broadcastSsid": true,
    • "ssid": "moxa-test-ap-1",
    • "security": {

      • "mode": "wpa2",
      • "encryption": "aes",
      • "password": ""

      },
    • "channel": 6,
    • "region": "TW",
    • "clients": [ ]

    }

  }

}

Update Wi-Fi interface configuration.

Update Wi-Fi interface configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer Interface id.

Request Body schema: application/json

	object (Wifi Information)
id integer Interface id mode required string Given Wi-Fi interface mode. Could be one of "ap", "client" enable required boolean Enable Wi-Fi Networking. status boolean Wi-Fi connection status. object Configuration of Wi-Fi AP mode. object Configuration of Wi-Fi Client mode.

Responses

https://127.0.0.1/api/v1/device/wifi/{id}

Request samples

• Payload

Content type

application/json

Example

APModeClientModeAPMode

{

• "type": "wifi",
• "id": 1,
• "name": "wlan0",
• "displayName": "Wi-Fi1",
• "mode": "ap",
• "enable": true,
• "ap": {

  • "band": "band24",
  • "broadcastSsid": true,
  • "ssid": "moxa-test-ap-1",
  • "security": {

    • "mode": "wpa2",
    • "encryption": "aes",
    • "password": ""

    },
  • "channel": 6,
  • "region": "US"

  }

}

Response samples

• 200

Content type

application/json

Example

APModeClientModeAPMode

{

• "data": {

  • "type": "wifi",
  • "id": 1,
  • "name": "wlan0",
  • "displayName": "Wi-Fi1",
  • "mode": "ap",
  • "enable": true,
  • "ap": {

    • "band": "band24",
    • "broadcastSsid": true,
    • "ssid": "moxa-test-ap-1",
    • "security": {

      • "mode": "wpa2",
      • "encryption": "aes",
      • "password": ""

      },
    • "channel": 11,
    • "region": "US"

    }

  }

}

Get Wi-Fi client networks list

Get Wi-Fi client networks list

Authorizations:

bearerAuth

path Parameters

id required

integer Interface id.

Responses

https://127.0.0.1/api/v1/device/wifi/{id}/client/networks

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "uuid": "bzLJpU7MR",
    • "ssid": "moxa-test-ap-1",
    • "bssid": "10:c3:7b:c6:47:f8",
    • "security": {

      • "mode": "wpa2-personal",
      • "encryption": "aes",
      • "password": "!2345678"

      },
    • "signal": -17,
    • "band": "band50"

    }

  ]

}

Post a new Wi-Fi client network to list

Post a new Wi-Fi client network to list

Authorizations:

bearerAuth

path Parameters

id required

integer Interface id.

Request Body schema: application/json

ssid required	string Wi-Fi client network SSID
password required	string Wi-Fi client network password

Responses

https://127.0.0.1/api/v1/device/wifi/{id}/client/networks

Request samples

• Payload

Content type

application/json

{

• "ssid": "moxa-ap-2",
• "password": "!2345678"

}

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "uuid": "bzLJpU7MR",
    • "ssid": "moxa-test-ap-1",
    • "bssid": "10:c3:7b:c6:47:f8",
    • "security": {

      • "mode": "wpa2-personal",
      • "encryption": "aes",
      • "password": "!2345678"

      },
    • "signal": -17,
    • "band": "band50"

    },
  • {

    • "uuid": "kcpJpUnMR",
    • "ssid": "moxa-ap-2",
    • "bssid": "",
    • "security": {

      • "mode": "wpa2-personal",
      • "encryption": "aes",
      • "password": "!2345678"

      },
    • "signal": null,
    • "band": "band24"

    }

  ]

}

Update Wi-Fi client network password

Update Wi-Fi client network password

Authorizations:

bearerAuth

path Parameters

id required	integer Interface id.
uuid required	string uuid of Wifi client network

Request Body schema: application/json

ssid required	string Wi-Fi client network SSID
password required	string Wi-Fi client network password

Responses

https://127.0.0.1/api/v1/device/wifi/{id}/client/networks/{uuid}

Request samples

• Payload

Content type

application/json

{

• "password": "*7654321"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "uuid": "kcpJpUnMR",
  • "ssid": "moxa-test-ap-1",
  • "bssid": "10:c3:7b:c6:47:f8",
  • "security": {

    • "mode": "wpa2-personal",
    • "encryption": "aes",
    • "password": "*7654321"

    },
  • "signal": -17,
  • "band": "band50"

  }

}

Delete Wi-Fi client network

Delete Wi-Fi client network

Authorizations:

bearerAuth

path Parameters

id required	integer Interface id.
uuid required	string uuid of Wifi client network

Responses

https://127.0.0.1/api/v1/device/wifi/{id}/client/networks/{uuid}

Get Wi-Fi client networks scan results

Get Wi-Fi client networks scan results

Authorizations:

bearerAuth

path Parameters

id required

integer Interface id.

query Parameters

event

boolean Get runtime scan, ex: {[{ssid: moxa-test-ap-1, security:{mode: wpa2-personal, encryption: aes, support: true}, signal: -17, band: band50},{...}]}

Responses

https://127.0.0.1/api/v1/device/wifi/{id}/client/scan

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "ssid": "moxa-test-ap-1",
    • "security": {

      • "mode": "wpa2-personal",
      • "encryption": "aes",
      • "support": true

      },
    • "signal": -17,
    • "band": "band50"

    },
  • {

    • "ssid": "D-k",
    • "security": {

      • "mode": "none",
      • "encryption": "none",
      • "support": true

      },
    • "signal": -43,
    • "band": "band24"

    },
  • {

    • "ssid": "TP-k",
    • "security": {

      • "mode": "wpa2-enterprise",
      • "encryption": "aes",
      • "support": false

      },
    • "signal": -58,
    • "band": "band50"

    },
  • {

    • "ssid": "ASOS",
    • "security": {

      • "mode": "wpa-personal",
      • "encryption": "aes",
      • "support": false

      },
    • "signal": -69,
    • "band": "band24"

    },
  • {

    • "ssid": "Wow",
    • "security": {

      • "mode": "wpa2-personal",
      • "encryption": "tkip",
      • "support": true

      },
    • "signal": -72,
    • "band": "band24"

    },
  • {

    • "ssid": "Mom",
    • "security": {

      • "mode": "wpa-personal",
      • "encryption": "tkip",
      • "support": false

      },
    • "signal": -75,
    • "band": "band24"

    }

  ]

}

firewall

Get device firewall of port forwarding configurati

Get device firewall of port forwarding configuration

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/firewall/portforwarding

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "lock": false,
    • "priority": 10,
    • "protocol": "tcp",
    • "externalPort": "502",
    • "internalIp": "192.168.3.100",
    • "internalPort": "502"

    },
  • {

    • "id": 2,
    • "enable": true,
    • "lock": false,
    • "priority": 10,
    • "protocol": "tcp",
    • "externalPort": "503",
    • "internalIp": "192.168.3.101",
    • "internalPort": "503"

    }

  ],
• "count": 2

}

Post device firewall of port forwarding configurat

Post device firewall of port forwarding configuration

Authorizations:

bearerAuth

query Parameters

unlock

boolean Default: false Examples: unlock=true - unlock=false -

Request Body schema: application/json

id	integer Port mapping rule id.
enable	boolean Default: false Port mapping rule enable/disable.
lock	boolean Default: false Lock the rule, not to be DELETE or PATCH directly, need with unlock=true at query string when DELETE or PATCH.
priority	integer Rule priority. It's an optional parameter, system will arrange a lowest priority(10) if property doesn't exist in payload. 1-5 are system reserved priority rule, need with unlock=true at query string when POST or DELETE or PATCH.
protocol required	string Enum: "tcp" "udp" "both" Rule handles the specified protcol.
externalPort required	string Forward destination port number. Support: 502 502-504
internalIp required	string Forward source IP address. Support: 192.168.0.1
internalPort required	string Forward source port number. Support: 502 502-504

Responses

https://127.0.0.1/api/v1/device/firewall/portforwarding

Request samples

• Payload

Content type

application/json

[

• {

  • "enable": true,
  • "lock": false,
  • "protocol": "tcp",
  • "externalPort": "502",
  • "internalIp": "192.168.3.100",
  • "internalPort": "502"

  },
• {

  • "enable": true,
  • "lock": false,
  • "protocol": "tcp",
  • "externalPort": "503",
  • "internalIp": "192.168.3.101",
  • "internalPort": "503"

  }

]

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "lock": false,
    • "priority": 10,
    • "protocol": "tcp",
    • "externalPort": "502",
    • "internalIp": "192.168.3.100",
    • "internalPort": "502"

    },
  • {

    • "id": 1,
    • "enable": true,
    • "lock": false,
    • "priority": 10,
    • "protocol": "tcp",
    • "externalPort": "503",
    • "internalIp": "192.168.3.101",
    • "internalPort": "503"

    }

  ],
• "count": 2

}

Patch device firewall of port forwarding configura

Patch device firewall of port forwarding configuration

Authorizations:

bearerAuth

query Parameters

unlock

boolean Default: false Examples: unlock=true - unlock=false -

Request Body schema: application/json

Array

id	integer Port mapping rule id.
enable	boolean Default: false Port mapping rule enable/disable.
lock	boolean Default: false Lock the rule, not to be DELETE or PATCH directly, need with unlock=true at query string when DELETE or PATCH.
priority	integer Rule priority. It's an optional parameter, system will arrange a lowest priority(10) if property doesn't exist in payload. 1-5 are system reserved priority rule, need with unlock=true at query string when POST or DELETE or PATCH.
protocol required	string Enum: "tcp" "udp" "both" Rule handles the specified protcol.
externalPort required	string Forward destination port number. Support: 502 502-504
internalIp required	string Forward source IP address. Support: 192.168.0.1
internalPort required	string Forward source port number. Support: 502 502-504

Responses

https://127.0.0.1/api/v1/device/firewall/portforwarding

Request samples

• Payload

Content type

application/json

[

• {

  • "id": 1,
  • "protocol": "tcp",
  • "externalPort": "10502",
  • "internalIp": "192.168.3.100",
  • "internalPort": "502"

  }

]

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "lock": false,
    • "priority": 10,
    • "protocol": "tcp",
    • "externalPort": "10502",
    • "internalIp": "192.168.3.100",
    • "internalPort": "502"

    }

  ],
• "count": 1

}

Delete device firewall of port forwarding configur

Delete device firewall of port forwarding configuration

Authorizations:

bearerAuth

query Parameters

unlock	boolean Default: false Examples: unlock=true - unlock=false - Enable to delete locked rule.
flush	boolean Default: false Examples: flush=true - flush=false - Flush all port forwarding rules or not. To delete locked rule, need with unlock=true in query string.

Request Body schema: application/json

Array

integer

Responses

https://127.0.0.1/api/v1/device/firewall/portforwarding

Request samples

• Payload

Content type

application/json

Example

Delete ID 1Delete ID 1,2Delete ID 1,2,3 but ID 3 not existDelete ID 1

[

• 1

]

Response samples

• 200

Content type

application/json

Example

Delete ID 1Delete ID 1,2Delete ID 1,2,3 but ID 3 not existDelete ID 1

{

• "data": [

  • 1

  ]

}

Get device firewall of port forwarding configurati

Get device firewall of port forwarding configuration

Authorizations:

bearerAuth

path Parameters

id required

integer Examples: 1 -

Responses

https://127.0.0.1/api/v1/device/firewall/portforwarding/{id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "lock": false,
  • "priority": 10,
  • "protocol": "tcp",
  • "externalPort": "502",
  • "internalIp": "192.168.3.100",
  • "internalPort": "502"

  }

}

Patch device firewall of port forwarding configura

Patch device firewall of port forwarding configuration

Authorizations:

bearerAuth

path Parameters

id required

integer Examples: 1 -

query Parameters

unlock

boolean Default: false Examples: unlock=true - unlock=false -

Request Body schema: application/json

id	integer Port mapping rule id.
enable	boolean Default: false Port mapping rule enable/disable.
lock	boolean Default: false Lock the rule, not to be DELETE or PATCH directly, need with unlock=true at query string when DELETE or PATCH.
priority	integer Rule priority. It's an optional parameter, system will arrange a lowest priority(10) if property doesn't exist in payload. 1-5 are system reserved priority rule, need with unlock=true at query string when POST or DELETE or PATCH.
protocol required	string Enum: "tcp" "udp" "both" Rule handles the specified protcol.
externalPort required	string Forward destination port number. Support: 502 502-504
internalIp required	string Forward source IP address. Support: 192.168.0.1
internalPort required	string Forward source port number. Support: 502 502-504

Responses

https://127.0.0.1/api/v1/device/firewall/portforwarding/{id}

Request samples

• Payload

Content type

application/json

{

• "protocol": "tcp",
• "externalPort": "10502",
• "internalIp": "192.168.3.100",
• "internalPort": "502"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "lock": false,
  • "priority": 10,
  • "protocol": "tcp",
  • "externalPort": "10502",
  • "internalIp": "192.168.3.100",
  • "internalPort": "502"

  }

}

Delete device firewall of port forwarding configur

Delete device firewall of port forwarding configuration

Authorizations:

bearerAuth

path Parameters

id required

integer Examples: 1 -

query Parameters

unlock

boolean Default: false Examples: unlock=true - unlock=false -

Responses

https://127.0.0.1/api/v1/device/firewall/portforwarding/{id}

systemtags

Get data of system status tags.

Get data of system status tags.

Authorizations:

bearerAuth

query Parameters

streamInterval required

integer Example: streamInterval=1000 stream interval with msec

tags required

Array of strings Items Enum: "cpuUser" "cpuSystem" "cpuIdle" "cpuNice" "cpuIowait" "cpuIrq" "cpuSoftirq" "cpuSteal" "cpuUsage" "memoryTotal" "memoryUsed" "memoryFree" "memoryShared" "memoryBuffers" "memoryCached" "memoryUsage" "gpsSignal" "cellular1Signal" Examples: tags=cpuUsage,memoryTotal,memoryUsage - example of multiple tags tag name(s). for cellular signal, it could be cellular1Signal for cellular module 1, cellular2Signal for cellular module 2.

Responses

https://127.0.0.1/api/v1/tags/monitor/system/status

Response samples

• 200

Content type

text/event-stream

[
  {
    "prvdName": "system",
    "srcName": "status",
    "tagName": "cpuUsage",
    "ts": 1590135215774,
    "dataType": "int64",
    "dataValue": 44
  },
  {
    "prvdName": "system",
    "srcName": "status",
    "tagName": "memoryTotal",
    "ts": 1590135211806,
    "dataType": "uint64",
    "dataValue": 2116034560
  },
  {
    "prvdName": "system",
    "srcName": "status",
    "tagName": "memoryUsage",
    "ts": 1590135214896,
    "dataType": "uint64",
    "dataValue": 26
  }
]

Get data of system storage tags.

Get data of system storage tags.

Authorizations:

bearerAuth

query Parameters

streamInterval required	integer Example: streamInterval=1000 stream interval with msec
tags required	Array of strings Items Enum: "systemDiskUsed" "systemDiskFree" "systemDiskPercent" "sd1-1DiskUsed" "sd1-1DiskFree" "sd1-1DiskPercent" Examples: tags=systemDiskPercent,sd1-1DiskPercent - example of multiple tags tag name(s). for SD card inserted and enabled, sd1-1DiskUsed, sd1-1DiskFree, sd1-1DiskPercent will be available.

Responses

https://127.0.0.1/api/v1/tags/monitor/system/storage

Response samples

• 200

Content type

text/event-stream

[
  {
    "prvdName": "system",
    "srcName": "storage",
    "tagName": "systemDiskPercent",
    "ts": 1590135558356,
    "dataType": "double",
    "dataValue": 26.705404330196146
  },
  {
    "prvdName": "system",
    "srcName": "storage",
    "tagName": "sd1-1DiskPercent",
    "ts": 1590135558363,
    "dataType": "double",
    "dataValue": 10.081168276727597
  }
]

Get data of system network usage tags.

Get data of system network usage tags.

Authorizations:

bearerAuth

query Parameters

streamInterval required

integer Example: streamInterval=1000 stream interval with msec

tags required

Array of strings Items Enum: "networkUsage" "networkTx" "networkRx" "cellular1NetworkUsage" "cellular1NetworkTx" "cellular1NetworkRx" "lan1NetworkUsage" "lan1NetworkTx" "lan1NetworkRx" Examples: tags=networkUsage,networkTx,networkRx - example of multiple tags tag name(s). for WAN interface use networkUsage, networkTx, networkRx. for cellular module inserted and enabled, cellular1NetworkUsage, cellular1NetworkTx, cellular1NetworkRx will be available.

Responses

https://127.0.0.1/api/v1/tags/monitor/system/network

Response samples

• 200

Content type

text/event-stream

[
  {
    "prvdName": "system",
    "srcName": "network",
    "tagName": "networkUsage",
    "ts": 1590135784561,
    "dataType": "uint64",
    "dataValue": 64842809
  },
  {
    "prvdName": "system",
    "srcName": "network",
    "tagName": "networkTx",
    "ts": 1590135784567,
    "dataType": "uint64",
    "dataValue": 4107946
  },
  {
    "prvdName": "system",
    "srcName": "network",
    "tagName": "networkRx",
    "ts": 1590135784573,
    "dataType": "uint64",
    "dataValue": 60734927
  }
]

platform

Get tag list of device app

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/device/platform/device-tags

Response samples

• 200
• 400

Content type

application/json

{

• "data": [

  • {

    • "prvdName": "system",
    • "srcName": "storage",
    • "tagName": "systemDiskFree",
    • "dataType": "uint64",
    • "access": "r",
    • "dataUnit": ""

    },
  • {

    • "prvdName": "system",
    • "srcName": "storage",
    • "tagName": "systemDiskPercent",
    • "dataType": "double",
    • "access": "r",
    • "dataUnit": ""

    }

  ]

}