Convergence API
Description This document describes Convergence API and provides the information regarding the changes that were made in the requests and collections compare to AEP 1.7.2 and MTR 4.1
All the changes are marked in RED. The table below provides examples and clarification regarding the API that can
Element Type Description Conv AEP MTR Description
checkin_to_devicehq ACTION Triggers a check-in to DeviceHQ + + + No changes. It means that this element is the same in AEP 1.7, MTR 4.1 and Convergence.
bootloader_console ACTION Controls bootloader silent mode + - - New element in Convergence. AEP 1.7 and MTR 4.1 do not have this element.
call_home_disable ACTION Disables call home feature with + + - Element is present in AEP 1.7, but is NOT present in MTR 4.1. Convergence DeviceHQ includes it. If we compare AEP1.7 and Convergence AEP, there is no difference. If we compare MTR 4.1 and Convergence MTR, there is a difference.
passwd ACTION Changes or resets user login + - + Element is NOT present in AEP 1.7, but is information including username, ID, present in MTR 4.1. Convergence and password includes it. If we compare AEP1.7 and Convergence AEP, there is a difference. If we compare MTR 4.1 and Convergence MTR, there is no difference.
auto - + - Element WAS present in AEP 1.7, but is NOT present in Convergence any more.
The following requests, collections and end-points are described in this document:
Commands ...... 4 customApps ...... 6 Collections ...... 6 alert ...... 9 appStore ...... 11 apps ...... 11 autoDialout ...... 12
Convergence API Version 2.2 P a g e | 1
autoReboot ...... 12 backOffTimers ...... 12 bluetooth ...... 13 bluetoothLowEnergy ...... 13 bootloader ...... 14 brand ...... 14 btDevices ...... 16 cacertificates ...... 16 certificate ...... 16 customDiagnostic ...... 17 databaseInfo ...... 18 ddns ...... 18 devices ...... 19 dhcp ...... 19 dns ...... 21 filters ...... 21 firewall ...... 22 gccp ...... 22 gps ...... 22 greTunnels ...... 24 ipPipes ...... 24 ipsecTunnels ...... 25 lan ...... 27 legacyDefaults ...... 27 lora ...... 27 loraNetwork ...... 29 nat ...... 36 ni ...... 37 nodeRed ...... 38 ovpnTunnels ...... 38 policy ...... 38 powerManagement ...... 38 ppp ...... 39 radius ...... 41
Convergence API Version 2.2 P a g e | 2
remoteAccess ...... 42 remoteManagement ...... 44 routes...... 45 secureProtocols ...... 45 selfDiagnostic ...... 46 serial ...... 46 serialModemPassthrough ...... 47 sms ...... 47 smtp ...... 49 snmp ...... 49 sntp ...... 51 stats ...... 51 syslog ...... 71 system ...... 72 telnet ...... 74 telnetServer ...... 75 trustedIp ...... 75 users ...... 75 waninfo ...... 76 wanmngr ...... 77 wifi ...... 77 networks ...... 79 status ...... 79 Change History ...... 80
Convergence API Version 2.2 P a g e | 3
Commands Commands are requests that processing by commandController.
Description: The API supports a set of special actions using the Command URL ( api/command ). Execute a command using a POST request call method. A RESTful Get request returns an array of all available commands. : OBJECT
Element Type Description Conv AEP MTR
bootloader_console ACTION Controls bootloader silent mode + - -
bootloader_lock ACTION Controls password authentication to access the device bootloader + - -
call_home_disable ACTION Disables call home feature with DeviceHQ + + -
call_home_enable ACTION Enables call home feature with DeviceHQ + + -
checkin_to_devicehq ACTION Triggers a check-in to DeviceHQ + + +
clean_oem ACTION Clears user-defined default configurations from memory and + + + returns the device to factory default
ddns_update ACTION Pushes DDNS information to the configured DDNS server + + +
download_config ACTION Downloads the current configuration + + +
firmware_check ACTION Uploads firmware file to device and checks it (POST mtr upgrade + - + bin file)
firmware_pre_upgrade ACTION Prepares system for firmware upgrade (i.e. shuts down Node-RED, + + + frees space for the upgrade package)
firmware_upgrade ACTION Upgrades device firmware + + +
legacy_sync ACTION Synchronizes legacy configurations + + +
loglvl_debug ACTION Sets the systems logging level to DEBUG + + +
loglvl_info ACTION Sets the systems logging level to INFO + + +
loglvl_trace ACTION Sets the systems logging level to TRACE + + +
loglvl_warning ACTION Sets the systems logging level to WARNING + + +
node_red_status ACTION Operational status of the Node-RED server + + -
passwd ACTION Changes or resets user login information including username, ID, + - + and password
ping ACTION Send a set of ICMP pings to an address or FQDN, interface can be + + + ANY, LAN, WIFI, WIFI-AP, CELLULAR, or ETHERNET (POST 'ip' and 'interface' in JSON)
Convergence API Version 2.2 P a g e | 4
Element Type Description Conv AEP MTR
ppp_start ACTION Start PPPD + + +
ppp_stop ACTION Stop PPPD + + +
ppp_toggle ACTION Toggle PPPD + + +
radio-cmd ACTION Sends a string directly to the cellular radio, timeout must be in + + + milliseconds
radio_activate ACTION Attempts to activate the on-board cellular radio (CDMA) + + +
radio_cmd ACTION Sends a string directly to the cellular radio, timeout must be in + - + milliseconds
radio_rfsurvey ACTION Performs RF survey of cellular module (may only be available on + - - certain models)
remove_icon ACTION Deletes user-supplied icon + + +
remove_image ACTION Deletes user-supplied image + + +
remove_logo ACTION Deletes user-supplied logo + + +
reset_bluetooth ACTION Resets the Bluetooth hardware + + +
reset_modem ACTION Resets the cellular radio hardware + + +
reset_wifi ACTION Resets the WiFi hardware + + +
restart ACTION Restarts device + + +
restart_node_red ACTION Restarts Node-RED server + + -
restore_defaults ACTION Resets the device with user-defined defaults if set, otherwise + + + factory
restore_factory ACTION Resets the device with factory defaults + + +
revert ACTION Reverts all changes since the last save + + +
save ACTION Saves the current configuration + + +
save_oem ACTION Saves current configuration as factory/OEM default + + +
save_restart ACTION Saves the current configuration and restarts the device + + +
sms_send ACTION Send a text to a specified recipient + + +
telit_check_fota_updates ACTION Get information on Telit Radio Firmware Upgrade + - +
telit_fota_upgrade ACTION Initiates Telit radio firmware upgrade from external site + - +
Convergence API Version 2.2 P a g e | 5
Element Type Description Conv AEP MTR
telit_upgrade ACTION Initiates Telit radio firmware upgrade (POST Telit upgrade bin) + + +
upload_config ACTION Uploads and sets new configuration (POST configuration file) + + +
upload_icon ACTION Uploads and sets new icon (POST icon file) + + +
upload_image ACTION Uploads and sets new image (POST image file) + + +
upload_logo ACTION Uploads and sets new logo (POST logo file) + + + customApps Description: Manages installed custom applications : OBJECT
Element Type Description Conv AEP MTR
_id STRING Device HQ application UUID + - -
description STRING Short description of the application + - -
info STRING Application generated information to display on Device HQ + - -
name STRING Name of the custom application + - -
status STRING Current status of the application (STARTED, STOPPED, RUNNING) + - -
version STRING Version of the currently installed application + - -
versionNotes STRING Any relevant notes on the currently installed application + - - pertaining to the version
Collections Collections are groups of related elements used to configure a service or capability. There are four main actions that can be performed on a collection: get, edit, add, and delete. These actions align with RESTful calls: GET, PUT, POST, and DELETE.
Collection Type Description Conv AEP MTR
alert OBJECT The alerts array contains predefined number of elements; each + - + defines settings for particular type of alert. A set of settings applicable for different alert types is different
appStore OBJECT Defines settings for Application Store + + -
apps ARRAY Contains information on installed Node-RED applications + + -
autoDialout OBJECT Allows the use of the cellular modem directly from the serial port + + +
Convergence API Version 2.2 P a g e | 6
Collection Type Description Conv AEP MTR
autoReboot OBJECT Causes the device to reboot automatically + + +
backOffTimers OBJECT Stores carrier-defined backoff timers for PPP connections, SMS + + + retries, and modem resets
bluetooth OBJECT allow a device to connect via Bluetooth + + +
bluetoothLowEnergy OBJECT Allows connecting devices via BLE + + -
bootloader OBJECT Bootloader configuration parameters + + -
brand OBJECT Customizes icons, images, and support information for a + + + rebranded device
btDevices ARRAY List of available Bluetooth devices + - -
cacertificates OBJECT Management of CA (Certifying Authority) certificates + + +
certificate OBJECT Contains secure public key certificate configurations + + +
command OBJECT The API supports a set of special actions using the Command URL + + + ( api/command ). Execute a command using a POST request call method. A RESTful Get request returns an array of all available commands.
customApps OBJECT Manages installed custom applications + + -
customDiagnostic OBJECT Custom diagnostic page settings + - +
databaseInfo OBJECT NOTE: not a part of public API (do not share) + + +
ddns OBJECT Updates the dynamic domain name server when the IP address + + + changes
devices ARRAY A list of saved devices + + +
dhcp OBJECT Stores DHCP settings + + +
dns OBJECT DNS forwarding configuration + + +
filters ARRAY Stores a list of firewall filters + + +
firewall OBJECT NOTE: not a part of public API (do not share) + + +
gccp OBJECT Stores the settings for the GCCP application + + +
gps OBJECT Stores the GPS service settings + + +
greTunnels ARRAY Stores a list of GRE tunnels + + +
ipPipes ARRAY Stores a list of configured IP pipes + + +
Convergence API Version 2.2 P a g e | 7
Collection Type Description Conv AEP MTR
ipsecTunnels ARRAY Stores a list of IPsec tunnels + + +
lan OBJECT Defines the LAN interface settings for PPP-IP PASSTHROUGH and + + + SERIAL-MODEM PASSTHROUGH modes only
legacyDefaults OBJECT NOTE: not a part of public API (do not share) + + +
lora lora API options are only available when LoRa Network Server is + + - running
loraNetwork OBJECT lora network interface settings + + -
nat ARRAY Stores a list of NAT rules for advanced firewall settings + + +
ni OBJECT Settings for network interfaces + + -
nodeRed OBJECT Node-RED configuration + + -
ovpnTunnels ARRAY List of configured OpenVPN tunnels + + +
policy OBJECT Contains usage policy settings + - +
powerManagement OBJECT NOTE: this is outdated collection and not to be used anymore (do + + + not share)
ppp OBJECT Defines the PPP settings + + +
radius OBJECT Configures Radius settings + - +
remoteAccess OBJECT Defines settings for remote access of the device + + +
remoteManagement OBJECT remote management settings + + +
routes ARRAY Stores a list of static routes + + +
secureProtocols ARRAY Cipher suites and advanced security options + - +
selfDiagnostic OBJECT Self-diagnostic settings + - +
serial OBJECT Defines the serial port settings + + +
serialModemPassthrough OBJECT Defines serial modem mode settings + - +
sms OBJECT Defines the SMS settings + + +
smtp OBJECT Defines the SMTP settings + + +
snmp OBJECT Defines the SNMP settings + - +
sntp OBJECT Defines the clock synchronization settings with a remote SNTP + + + server
Convergence API Version 2.2 P a g e | 8
Collection Type Description Conv AEP MTR
stats OBJECT statistics on services and interfaces + + +
syslog OBJECT Defines the syslog support settings + + +
system OBJECT Defines the system attributes + + +
telnet OBJECT NOTE: this is outdated collection and not to be used anymore (do + + + not share)
telnetServer OBJECT NOTE: this is outdated collection and not to be used anymore (do + - + not share)
trustedIp OBJECT Filter incoming packets depending on the white or black IP + - + addresses list
users ARRAY Stores a list of users for authentication purposes + + +
waninfo OBJECT Stores information on WAN interfaces + + +
wanmngr OBJECT Defines the WAN management settings + + +
wifi OBJECT Defines the Wi-Fi services settings + + +
networks ARRAY array of networks to be used in setting filters and tunnels - + +
status OBJECT NOTE: this is not a part of public API (do not share) - + - alert Description: The alerts array contains predefined number of elements; each defines settings for particular type of alert. A set of settings applicable for different alert types is different : OBJECT
Element Type Description Conv AEP MTR
alerts ARRAY List of notifications available for configuration + - +
alertOn INT Data usage amount in % when device should send an alert + - + (default : 80)
count INT The number of requests that must be sent (default : 10) + - +
dataAllowedPerMonth INT Amount of data allowed per month in data plan in Mb + - +
dataPlanStartDate INT A day of month when data plan resets (default : 1) + - +
dataPlanType STRING Billing cycle type, use "Monthly" to set the day of the month + - + when the billing cycle starts, or "Custom Interval" to set the number of days in the billing cycle (default : Monthly)
email BOOL Enables or disables sending notifications by email (default:false) + - +
Convergence API Version 2.2 P a g e | 9
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables notification (default:false) + - +
event STRING Event ID: "Data Usage", "Signal Strength", "Device Reboot", + - + "Ethernet Failure", "WifiWan Failure", "Cellular Failure", "Ethernet Traffic", "Wifi Traffic", "Cellular Traffic", "WAN Failover", "Ping Failure", "Security Violation", "Flash Memory Violation", "Resources Overuse"
failThreshold INT The number of failed requests that will trigger the notification + - +
failoverEvent STRING WAN Failover alert trigger. Valid values are 'Always', 'Interface + - + went down' and 'Interface came up'. 'Always' - the notification is sent every time when WAN Transport is changed; 'Interface went down' - the notification is sent only when the current interface is switched to the one that has lower priority; 'Interface came up' - the notification is sent only when the current interface is switched to the one that has higher priority. (default:'Always')
interval INT For the Signal Strength, Ethernet, Wi-Fi as WAN and Cellular + - + Failure it is the amount of time in seconds when a notification should be sent (default:60). For the Data Usage it is the number of days in the billing cycle interval when the data plan is reset (default:30)
intervalStartDate STRING Day of the beginning of billing cycle for data plan with "Custom + - + Interval" type
ipAddress STRING IP Address or hostname + - +
minWaitTimeAfterAlarm INT Interval in hours before subsequent notifications for the low + - + signal strength event are issued (default : 24)
minWaitTimeAfterStart INT For WAN Failover alert, the period of time in seconds during + - + which the system does not monitor WAN failover statuses on start-up (default:60, min:60)
netIface STRING The notification will be sent through the specified interface + - + (default : "ANY")
notifyGroup STRING The name of recipient group that receives notification + - +
periodicInterval INT Interval in hours between notifications for data traffic + - + notifications (default:24)
pingInterval INT Interval in minutes for performing ping test + - +
signalStrength INT Signal strength threshold in dBm (default:-60) + - +
sms BOOL Enables or disables sending notifications via sms (default : false) + - +
Convergence API Version 2.2 P a g e | 10
Element Type Description Conv AEP MTR
snmp BOOL Enables or disables sending SNMP trap notifications (default : + - + false)
groups ARRAY List of recipient groups that receive notifications. + - +
emails ARRAY List of recipient emails + - +
email STRING Recipient email address + - +
name STRING Recipient name + - +
name STRING Recipient group name + - +
phones ARRAY List of recipient phone numbers + - +
name STRING Recipient name + - +
phone STRING Recipient phone number + - + appStore Description: Defines settings for Application Store : OBJECT
Element Type Description Con AEP MTR
appStoreUrl STRING URL that the device will connect to for uploading and + + - downloading apps from the Application Store on the DeviceHQ server
dependencyUrl STRING Dependency URL + + - apps Description: Contains information on installed Node-RED applications : ARRAY
Element Type Description Conv AEP MTR
_id STRING Device HQ application UUID + + -
enabled BOOL Enables or disables the application + + -
name STRING Specifies the name of the application + + -
platform STRING Currently "Node-RED" only + + -
status STRING Current status of the application (STARTED, STOPPED, RUNNING, + + - UPDATING)
type STRING Application type + + -
version STRING Version of the currently installed application + + -
Convergence API Version 2.2 P a g e | 11
Element Type Description Conv AEP MTR
versions ARRAY A list of objects each representing an application version + + -
version STRING Application version + + - autoDialout Description: Allows the use of the cellular modem directly from the serial port : OBJECT
Element Type Description Conv AEP MTR
eia BOOL Enable or disable EIA standard signal characteristics (default:false) + + +
enabled BOOL Enable or disable this feature (default:true) + + +
inactivity UINT Set inactivity timeout in seconds set to 0 to disable (default:0) + + +
login BOOL Enable or disable login requirement (default:true) + + +
port UINT Configure port to use when connecting to the device + + + (default:5000)
raw BOOL Enable or disable raw mode (default:false) + + +
tcpKeepaliveInterval UINT Determines the interval between subsequent keepalive probes, + + + regardless of what the connection has exchanged elsewhere (default:75)
tcpKeepaliveProbes UINT Defines the interval between the last data packet sent (simple + + + ACKs are not considered data) and the first keepalive probe; after the connection is marked with keepalive, this counter is no longer used (default:7200)
tcpKeepaliveTime UINT Determines the number of unacknowledged probes to send + + + before considering the connection dead and notifying the application layer (default:9) autoReboot Description: Causes the device to reboot automatically : OBJECT
Element Type Description Conv AEP MTR
hour UINT Defines either the Hour of Day or the Hours from Boot, based on + + + the mode
mode STRING Defines the mode of the hour element, can be DISABLED, TIME, or + + + TIMER (default: DISABLED) backOffTimers Description: Stores carrier-defined backoff timers for PPP connections, SMS retries, and modem resets : OBJECT
Convergence API Version 2.2 P a g e | 12
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables backOffTimers feature (default:true) + + +
timers ARRAY Contains a list of backoff timers + + +
carrierName STRING Displays the name of the carrier + + +
data ARRAY Contains data timers, defining the interval between cellular + + + connection attempts in seconds
dataReset ARRAY Contains data reset timers, defining the interval between + + + connection reset attempts in seconds
modemReset ARRAY Contains modem reset timers, defining the interval between + + + resetting the modem in seconds
readOnly BOOL Determines whether the timers are read-only + + +
sms ARRAY Contains SMS timers, defining the interval between attempts to + + + send an SMS in seconds bluetooth Description: allow a device to connect via Bluetooth : OBJECT
Element Type Description Conv AEP MTR
device OBJECT Defines the Bluetooth settings of a connected device + + +
address STRING Specifies the MAC address of a Bluetooth device + + +
name STRING Specifies the name of a Bluetooth device + + +
devices OBJECT NOTE: devices is outdated collection and not to be used anymore + + + (do not share)
address STRING mac address of device - + +
name STRING label for device - + +
enabled BOOL Enable or disable Bluetooth (default:false) + + +
savedDevices ARRAY Contains a list of saved Bluetooth devices + + +
address STRING Displays the MAC address of a Bluetooth device + + +
friendlyName STRING Displays the user-defined name of a Bluetooth device + + +
name STRING Displays the scanned name of a Bluetooth device + + + bluetoothLowEnergy Description: Allows connecting devices via BLE : OBJECT
Convergence API Version 2.2 P a g e | 13
Element Type Description Conv AEP MTR
device OBJECT Bluetooth low energy device settings + + -
address STRING MAC address of the Bluetooth device + + -
interface STRING Interface of the Bluetooth device + + -
name STRING Name of the Bluetooth device + + -
devices ARRAY list of the Bluetooth low energy devices found during last scan + + -
address STRING MAC address of the device + + -
name STRING Name of the device + + -
enabled BOOL Enable or disable Bluetooth low energy feature (default:false) + + -
powerRfRx STRING Bluetooth radio frequency power RX + + -
powerRfTotal STRING Bluetooth radio frequency power total + + -
powerRfTx STRING Bluetooth radio frequency power TX + + -
savedDevices ARRAY list of the saved Bluetooth devices + + -
address STRING MAC address of the device + + -
friendlyName STRING User defined name of the device + + -
name STRING Scanned name of the device + + - bootloader Description: Bootloader configuration parameters : OBJECT
Element Type Description Conv AEP MTR
console OBJECT Bootloader silent mode status + - -
silent BOOL Current bootloader silent mode status + - -
lock OBJECT Bootloader password protection status + + -
enabled BOOL Current bootloader password protection status + + -
password STRING Indicates bootloader password + + -
supported BOOL Indicates password protection support by the bootloader + + - brand Description: Customizes icons, images, and support information for a rebranded device : OBJECT
Convergence API Version 2.2 P a g e | 14
Element Type Description Conv AEP MTR
address1 STRING Displays the address of the support contact + + +
address2 STRING Displays the address of the support contact + + +
buttonColor STRING Displays button color in format #rrggbb (default:'') + + +
buttonFontColor STRING Displays button font color in format #rrggbb (default:'') + + +
buttonHighlightColor STRING Displays button highlight color in format #rrggbb (default:'') + + +
buttonHighlightFontColor STRING Displays button highlight font color in format #rrggbb (default:'') + + +
city STRING Displays the city of the support contact + + +
companyName STRING Displays the company name of the support contact + + +
country STRING Displays the country of the support contact + + +
fax STRING Displays the fax number of the support contact + + +
icon STRING Displays the image file name for custom favicon in browser + + +
image STRING Displays the image file name for custom image on the support + + + page
links ARRAY Contains a list of web links for customer support + + +
label STRING Displays the label for a hyperlink + + +
text STRING Displays the text of a hyperlink + + +
url STRING Displays the URL of a hyperlink + + +
logo STRING Displays the image file name for a custom logo in the header and + + + on the login page
phoneNumbers ARRAY Contains a list of phone numbers for customer support + + +
label STRING Displays the label of a phone number + + +
number STRING Displays a phone number + + +
showOnDashboard BOOL Enables or disables the display of brand information on the + + + support page (default:false)
state STRING Displays the website URL of the support contact + + +
website STRING Custom support contact: company website + + +
zipCode STRING Displays the zip code of the support contact + + +
Convergence API Version 2.2 P a g e | 15
btDevices Description: List of available Bluetooth devices : ARRAY
Element Type Description Conv AEP MTR
address STRING Displays the MAC address of a Bluetooth device + - -
connected BOOL Displays connected status of the Bluetooth device + - -
name STRING Displays the scanned name of a Bluetooth device + - -
paired BOOL Displays paired status of the Bluetooth device + - -
rssi STRING Displays the measurement of the power present in a received + - - radio signal (received signal strength indicator) of the Bluetooth device
trusted BOOL Displays paired status of the Bluetooth device + - - cacertificates Description: Management of CA (Certifying Authority) certificates : OBJECT
Element Type Description Conv AEP MTR
details ARRAY Displays the current certificate information + + +
details STRING Details of the certificate + + +
expired BOOL Is certificate expired + + +
filename STRING Name of the certificate + + +
periodFrom STRING Certificate start date + + +
periodTo STRING Certificate end date + + +
subject STRING Subject of the certificate + + +
remove ACTION Remove CA certificate + + +
upload ACTION Upload CA certificate + + + certificate
Description: Contains secure public key certificate configurations : OBJECT
Element Type Description Conv AEP MTR
create ACTION Creates a new certificate + + +
Convergence API Version 2.2 P a g e | 16
Element Type Description Conv AEP MTR
commonName STRING Defines the device IP address used to connect to device + + +
country STRING Displays the two-letter code for the country for which the + + + certificate is valid
days UINT Displays the number of days the certificate is valid (default:365) + + +
emailAddress STRING Displays the email address of the contact responsible for the + + + device
locality STRING Displays the city or locality for which the certificate is valid + + +
organization STRING Displays the organization name for which the certificate is valid + + +
state STRING Displays the state or province for which the certificate is valid + + +
details OBJECT Displays the current certificate information + + +
credentials STRING Displays the certificate subject description + + +
details STRING Displays the certificate details description + + +
periodFrom STRING Displays the certificate start date + + +
periodTo STRING Displays the certificate end date + + +
upload ACTION Uploads the new certificate (POST certificate file) + + + customDiagnostic Description: Custom diagnostic page settings : OBJECT
Element Type Description Conv AEP MTR
button1 OBJECT Configure a button on the custom diagnostic page that allows + - + pinging a single IP address or IP address range
enabled BOOL Enables or disables the button on the custom diagnostic page + - +
label STRING Specify the button label that will be displayed on the custom + - + diagnostic page
rangeEnd STRING Specify the end address in the IP range that you want to ping + - + when clicking the button.
rangeStart STRING Specify the start address in the IP range that you want to ping + - + when clicking the button.
button2 OBJECT Configure a button on the custom diagnostic page that allows + - + pinging a single IP address or IP address range
Convergence API Version 2.2 P a g e | 17
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables the button on the custom diagnostic page + - +
label STRING Specify the button label that will be displayed on the custom + - + diagnostic page
rangeEnd STRING Specify the end address in the IP range that you want to ping + - + when clicking the button.
rangeStart STRING Specify the start address in the IP range that you want to ping + - + when clicking the button.
button3 OBJECT Configure a button on the custom diagnostic page that allows + - + pinging a single IP address or IP address range
enabled BOOL Enables or disables the button on the custom diagnostic page + - +
label STRING Specify the button label that will be displayed on the custom + - + diagnostic page
rangeEnd STRING Specify the end address in the IP range that you want to ping + - + when clicking the button.
rangeStart STRING Specify the start address in the IP range that you want to ping + - + when clicking the button.
enabled BOOL Enables or disables an access to the custom diagnostic page + - +
lan BOOL Enables or disables an access to the custom diagnostic page via + - + LAN
port UINT Specify the port that will be used for accessing the custom + - + diagnostic page
wan BOOL Enables or disables an access to the custom diagnostic page via + - + WAN databaseInfo Description: : NOTE: this is not a part of public API (do not share)
Element Type Description Conv AEP MTR
timestamp STRING Specifies the time when database was saved (UTC) + + +
version STRING Database version + + + ddns Description: Updates the dynamic domain name server when the IP address changes : OBJECT
Element Type Description Conv AEP MTR
Convergence API Version 2.2 P a g e | 18
Element Type Description Conv AEP MTR
authentication OBJECT Contains the authentication information + + +
password STRING Displays the password for the DDNS account + + +
username STRING Displays the username for the DDNS account + + +
checkIp OBJECT Configures the remote server to which you are connecting + + +
enabled BOOL Enables or disables the check IP feature (default:true) + + +
port UINT Identifies the port on the remote server (default:80) + + +
server STRING Identifies the domain name of the remote server + + + (default:'checkip.dyndns.org')
domain STRING Identifies the registered domain name + + +
enabled BOOL Enables or disables the DDNS feature (default:false) + + +
port UINT Identifies the server’s port number (default:80) + + +
retriesMax UINT Defines the maximum number of connection attempts before + + + failure (default:5)
server STRING Identifies the name of the server associated with the currently + + + assigned IP address (default:'members.dyndns.org')
system STRING Identifies the system registration type, DYNAMIC or CUSTOM + + + (default:DYNAMIC)
updateInterval UINT Defines the number of days between forced updates (default:28) + + + devices Description: A list of saved devices : ARRAY
Element Type Description Conv AEP MTR
friendlyName STRING Identifies the user-friendly name associated with the device + + +
mac STRING Identifies the MAC address of the device + + +
name STRING Identifies the name of the device + + + dhcp Description: Stores DHCP settings : OBJECT
Element Type Description Conv AEP MTR
dhcps ARRAY List of the configured DHCPs + + -
Convergence API Version 2.2 P a g e | 19
Element Type Description Conv AEP MTR
defaultGateway STRING Specifies the default gateway of network (default:'192.168.2.1') + + -
domain STRING Specifies the network domain name + + -
enabled BOOL Enables or disables the DHCP server (default:true) + + -
fixedAddresses ARRAY Contains a list of fixed addresses + + -
ip STRING Specifies the IP address assigned to the client + + -
mac STRING Reports the client’s MAC address + + -
interface STRING Network interface name + + -
leaseTime UINT Specifies the number of seconds leases are issued for + + - (default:86400)
leases ARRAY Contains a list of the current leases issued by the DHCP server + + -
maxLeases UINT Maximum number of leases that can be issued (default:200) + + -
options ARRAY Contains a list of additional DHCP options + + -
rangeEnd STRING Specifies the IP address at the end of the DHCP lease range + + - (default:'192.168.2.254')
rangeStart STRING Specifies the IP address at the beginning of the DHCP lease range + + - (default:'192.168.2.100')
subnetAddress STRING Specifies the network’s subnet (default:'192.168.2.0') + + -
subnetMask STRING Specifies the network mask (default:'255.255.255.0') + + -
defaultGateway STRING default gateway of network (default:'192.168.2.1') - - +
domain STRING network domain name - - +
enabled BOOL enable or disable DHCP server (default:true) - - +
fixedAddresses ARRAY list of fixed addresses - - +
ip STRING ip address to assign to client - - +
mac STRING mac address of client - - +
leaseTime UINT number of seconds leases are issued for (default:86400) - - +
leases ARRAY current leases issued by DHCP server - - +
maxLeases UINT maximum number of leases that can be issued (default:200) - - +
Convergence API Version 2.2 P a g e | 20
Element Type Description Conv AEP MTR
options ARRAY an array of additional dhcp options - - +
rangeEnd STRING end ip address of dhcp lease range (default:'192.168.2.254') - - +
rangeStart STRING start ip address of dhcp lease range (default:'192.168.2.100') - - +
subnetAddress STRING subnet of network (default:'192.168.2.0') - - +
subnetMask STRING mask of network (default:'255.255.255.0') - - + dns Description: DNS forwarding configuration : OBJECT
Element Type Description Conv AEP MTR
enabled BOOL Enable or disable dns server (default:true) + + +
ipv6 OBJECT IPv6 mode settings + - +
primary STRING Specifies the static IPv6 address of primary DNS server (default:'') + - +
secondary STRING Specifies the static IPv6 address of secondary DNS server + - + (default:'')
options ARRAY Contains a list of additional DNS options + + +
primary STRING Specifies the static IP address of the primary DNS server + + +
secondary STRING Specifies the static IP address of the secondary DNS server + + + filters Description: Stores a list of firewall filters : ARRAY
Element Type Description Conv AEP MTR
__v UINT Version of model [2] (automatic) + + +
chain STRING Chain to apply the rule : INPUT, OUTPUT, or FORWARD + + +
description STRING Short description of the rule (optional) + + +
dstAddr STRING Destination IP address of packet (optional) + + +
dstInterface STRING Destination interface to apply rule (optional). examples [WAN], + + + [LAN], [CELLULAR], [WIFI]
dstMask STRING Destination IP mask (optional). examples [255.255.255.0], [24] + + +
Convergence API Version 2.2 P a g e | 21
Element Type Description Conv AEP MTR
dstPort STRING Destination IP port (optional). examples [5000], [6000:6002], + + + [5000,6000-6002,8000:8010]
enabled BOOL Enable or disable this rule + + +
name STRING Specifies the unique name of rule + + +
protocol STRING Specifies the packet protocol (optional). Examples [TCP], [UDP], + + + [TCP/UDP] and [ANY]
srcAddr STRING Specifies the source IP address of packet (optional) + + +
srcInterface STRING Specifies the source interface to apply rule (optional). Examples + + + [WAN], [LAN], [CELLULAR], [WIFI]
srcMac STRING Specifies the source MAC address + + +
srcMask STRING Specifies the source IP mask of packet (optional). examples + + + [255.255.255.0], [24]
srcPort STRING Specifies the source IP port (optional). examples [5000], + + + [6000:6002], [5000,6000-6002,8000:8010]
target STRING Target of the rule/filter: ACCEPT, REJECT, LOG or DROP + + + firewall Description: : NOTE: this is not a part of public API (do not share) gccp Description: Stores the settings for the GCCP application : OBJECT
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables the GCCP feature (default:false) + + +
port UINT Specifies the port to open on the device for a GCCP connection + + + (default:5000) gps Description: Stores the GPS service settings : OBJECT
Element Type Description Conv AEP MTR
client OBJECT Contains the settings for the GPS client + + +
enabled BOOL Enables or disables the GPS client (default:false) + + +
password STRING Specifies the password to use when connecting to the remote + + + server
Convergence API Version 2.2 P a g e | 22
Element Type Description Conv AEP MTR
port UINT Specifies the port to connect to on the remote server + + + (default:5445)
protocol STRING Specifies which protocol to use when making a connection, UDP + + + or TCP (default:TCP)
remoteHost STRING Specifies the IP address of the remote server + + + (default:'192.168.2.3')
coordinates OBJECT NOTE: the coordinates object is not a part of public API yet (do + + - not share)
altitude DOUBLE Specifies altitude + + -
fixStatus UINT Fix quality (0=No fix, 1=Have fix without DGPS, 2 = have fix with + + - DGPS)
latitude DOUBLE Specifies latitude + + -
longitude DOUBLE Specifies longitude + + -
numSatellites UINT Number of satellites used in solution + + -
timestamp DOUBLE Time of update + + -
nmea OBJECT Specifies what NMEA sentences to send and how often to send + + + them
enabled BOOL Causes the u-blox chip to enter NMEA only mode + + -
gga BOOL Identifies whether to send global positioning system fix data + + + (default:true)
gll BOOL Identifies whether to send geographic position, latitude/longitude + + + (default:true)
gsa BOOL Identifies whether to send GPS, DOP, and active satellites + + + (default:true)
gsv BOOL Identifies whether GPS Satellites are in view (default:true) + + +
id STRING Specifies an optional ID to attach to messages + + +
idPrefix STRING Specifies an optional prefix to attach to messages + + +
interval UINT Specifies how often to send GPS information, in seconds + + + (default:10)
rmc BOOL Identifies whether to send the recommended minimum specific + + + GPS/Transit data (default:true)
Convergence API Version 2.2 P a g e | 23
Element Type Description Conv AEP MTR
vtg BOOL Identifies the state of track made good and ground speed + + + (default:true)
server OBJECT Specifies the settings for the GPS server + + +
dumpSerialPort BOOL Identifies whether to output GPS information to the serial port + + + (default:false)
enabled BOOL Enables or disables the GPS server (default:false) + + +
password STRING Specifies the password needed for the client to connect to the + + + server
port UINT Specifies the port for the server to listen on (default:5445) + + + greTunnels Description: Stores a list of GRE tunnels : ARRAY
Element Type Description Conv AEP MTR
checkPeriod UINT Specifies the interval (in minutes) to resolve the remote peer + - - hostname. Recommended for hostnames that have dynamic IP addresses.
description STRING Specifies the description for a GRE tunnel + + +
enabled BOOL Enables or disables a tunnel + + +
name STRING Specifies the name of a tunnel + + +
remoteIP STRING Specifies the remote IP of a tunnel + + +
routes ARRAY Contains a list of tunnel routes + + +
ip STRING Specifies the IP address of a route + + +
mask STRING Specifies the network mask of a route (0-32) + + +
ttl UINT Specifies the time to live (0-255) + + + ipPipes Description: Stores a list of configured IP pipes : ARRAY
Element Type Description Conv AEP MTR
__v UINT Version of model [2] (automatic) + - +
activation STRING The signal to start a connection + + +
Convergence API Version 2.2 P a g e | 24
Element Type Description Conv AEP MTR
bufferTimeoutMs UINT Timeout after which the data will be sent to the network if the + - + buffer is not full (in milliseconds)
description STRING Summary or description of the pipe + + +
enabled BOOL Enables or disables a pipe + + +
ip STRING IP address of the remote end of the pipe + + +
mode STRING Specifies whether the local end point is a client, server, or both + + +
name STRING Label of the pipe + + +
port UINT Port number of the remote end point when in CLIENT mode, or + + + listening port when in SERVER mode
protocol STRING Specifies the internet protocol to use (UDP, TCP or SSL/TLS) + + +
secondaryIp STRING Specifies the IP address of the secondary server; this server is + + + contacted if a connection can not be made to the first, must be in CLIENT mode
secondaryPort UINT Specifies the port of the secondary server; this server is contacted + + + if a connection cannot be made to the first, must be in CLIENT mode
sequence STRING Character or stream of characters that terminate the pipe, + + + requires the termination mode to be SEQUENCE
serialReadBufSize UINT Size of buffer for reading data from serial port and sending to + - + network (in bytes)
source STRING Specifies the source defined by the local device to convert data to + + + and from IP communication
termination STRING Mode used for terminating the pipe + + +
timeoutSeconds UINT Amount of inactivity allowed before the pipe closes (in seconds), + + + requires the termination mode to be TIMEOUT
type STRING Type of pipe, currently only serial-to-ip and bluetooth-to-ip are + + + supported ipsecTunnels Description: Stores a list of IPsec tunnels : ARRAY
Element Type Description Conv AEP MTR
aggressiveMode BOOL Allows a less secure mode that exchanges identification in plain + + + text
Convergence API Version 2.2 P a g e | 25
Element Type Description Conv AEP MTR
authMethod STRING Specifies how two security gateways should authenticate each + + + other (secret or rsasig)
caCert STRING CA certificate in PEM format for rsasig authentication method + - +
compression BOOL Indicates whether IPComp compression of content is proposed on + + + the connection
description STRING Describes the tunnel + + +
enabled BOOL Enables or disables a tunnel + + +
encryptMethod STRING Specifies the IKE encryption/authentication algorithm used for + + + phase 1 and phase 2 of the connection
ikelife UINT Specifies how long the keying channel of the connection should + + + last before being renegotiated (hours)
keylife UINT Indicates the acceptable duration of a connection’s keying + + + channel before it must be renegotiated (hours)
localCert STRING Local peer certificate in PEM format for rsasig authentication + - + method
localId STRING Specifies the identification method for a local participant + + +
localPrivKey STRING Local peer private key in PEM format for rsasig authentication + - + method
name STRING Specifies the label of a tunnel + + +
natTraversal BOOL [OPTIONAL] Indicates the status of IPsec NAT workaround, accept + + + or offer to support
perfectForwardSecrecy BOOL Indicates the status of Perfect Forward Secrecy of keys on the + + + connection’s keying channel
phase1 STRING [OPTIONAL] Defines specific algorithms for phase 1. Format: + + + cipher-hash;group. Example: aes128-sha1;modp1024
phase2 STRING [OPTIONAL] Defines specific algorithms for phase 2. Format: + + + cipher-hash;group. Example: aes128-sha1;modp1024
psk STRING Specifies the pre-shared key for secret authentication method + + +
remoteId STRING Specifies how the remote participant should be identified for + + + authentication
remoteNetworkIp STRING Specifies the network on the remote end of a tunnel + + +
remoteNetworkMask UINT Specifies the network mask on the remote end of a tunnel + + +
Convergence API Version 2.2 P a g e | 26
Element Type Description Conv AEP MTR
remoteWanIp STRING Specifies the public IP on the remote end of a tunnel + + +
retries UINT Specifies the number of attempts to negotiate a connection or a + + + replacement for a connection before giving up
type STRING Specifies the type of IPsec tunnel: Internet Key Exchange is + + + currently the only supported type
uid BOOL Specifies whether or not tunnel end points should be identified + + + for authentication
remoteNetwork STRING saved network of remote end of tunnel - + + lan Description: Defines the LAN interface settings for PPP-IP PASSTHROUGH and SERIAL-MODEM PASSTHROUGH modes only : OBJECT
Element Type Description Conv AEP MTR
gateway STRING Specifies the default gateway (default:192.168.2.1) + + +
ip STRING Specifies the IP address (default:192.168.2.1) + + +
ipMode STRING Specifies the IP protocol support mode (default:IPv4) + - +
ipv6 OBJECT Contains IPv6 mode settings + - +
ip STRING Specifies the IPv6 address + - +
prefixlen STRING Specifies the IPv6 prefix length + - +
mask STRING Specifies the subnet mask (default:255.255.255.0) + + +
publicIpMask STRING Specifies the public IP Mask (default:255.255.255.255) + - +
auto - + - legacyDefaults Description: NOTE: this is not a part of public API (do not share) lora Description: lora API options are only available when LoRa Network Server is running :
NOTE: These endpoints needs to be updated. TODO is on Jason.
Element Type Description Conv AEP MTR
config show the current configuration of the network server + + -
Convergence API Version 2.2 P a g e | 27
Element Type Description Conv AEP MTR
devices ARRAY list of device configurations in network server + + -
DELETE UINT remove a device configuration + + -
GET ARRAY get the list of device configurations + + -
POST OBJECT add a device configuration + + -
PUT OBJECT update a device configuration + + -
keygen OBJECT generate a zero-touch appkey for an end-device + + -
gateways ARRAY list of gateways connect to the network server + + -
DELETE UINT remove a gateway from the list + + -
GET ARRAY get the list of gateways + + -
joinRequests ARRAY get the list of recent join requests + + -
packets ARRAY list of packets sent and received by network server + + -
GET ARRAY get the list of packets + + -
down ARRAY list of downlink packets + + -
join ARRAY list of join request and response packets + + -
queue ARRAY list of packets queued for downlink + + -
DELETE UINT remove an existing packet from the queue + + -
GET ARRAY get the list of packets + + -
POST OBJECT add a new packet to the downlink queue + + -
PUT OBJECT edit an existing packet in the queue + + -
up ARRAY list of uplink packets + + -
profiles OBJECT list of device or network profiles + + -
device ARRAY list of device profiles for default end-device settings + + -
DELETE UINT remove a device profile + + -
GET ARRAY get the list of device profiles + + -
POST OBJECT add a device profile + + -
network ARRAY list of network profiles for desired end-device settings + + -
Convergence API Version 2.2 P a g e | 28
Element Type Description Conv AEP MTR
DELETE UINT remove a network profile + + -
GET ARRAY get the list of network profiles + + -
POST OBJECT add a network profile + + -
sessions ARRAY list of device sessions connected to the network server + + -
DELETE UINT remove a device session + + -
GET ARRAY get the list of device sessions + + -
POST OBJECT add a device session + + - loraNetwork Description: lora network interface settings : OBJECT
NOTE: These endpoints needs to be updated. TODO is on Jason.
Element Type Description Con AEP MTR
__v UINT version of model [20] (automatic) + + -
addressRange OBJECT address range settings + + -
end STRING end of range for assigned addresses, four groups of two + + - hexadecimal digits, separated by colons
start STRING start of range for assigned addresses, four groups of two + + - hexadecimal digits, separated by colons
backupInterval + + -
db + + -
log OBJECT log settings + + -
console BOOL console + + -
level UINT log level + + -
path STRING path + + -
syslog BOOL syslog + + -
lora OBJECT lora settings + + -
ADRStep UINT Step in cB between SNR based datarate assignment for ADR + + -
aesKey + + -
Convergence API Version 2.2 P a g e | 29
antennaGain INT Gain of external antenna in dBi + + -
beaconFreqHop + + -
beaconFrequency + + -
beaconInfoDesc + + -
beaconInterval + + -
beaconLatitude + + -
beaconLongitude + + -
beaconPower + + -
calAD9361 + + -
calTempRoom + + -
channelMask + + -
channelPlan + + -
classCAckTimeout + + -
deviceQueueSize UINT device queue size for pending downlink packets + + -
diversity + + -
dspStatInterval + + -
dutyCyclePeriod UINT Length of duty-cycle sliding window in minutes + + -
dwelltimeDown UINT max dwelltime for downlink packets default: 0 - no limit, 1 - 400 + + - ms
dwelltimeUp UINT max dwelltime for uplink packets, default: 0 - no limit, 1 - 400 ms + + -
enableStrictCounterValidation + + -
enabled BOOL check to enable lora network support + + -
frequencyAS UINT center freq for extra AS channels (Hz) + + -
frequencyAS2 + + -
frequencyBand UINT frequency band + + -
frequencyBand2 + + -
frequencyEU UINT center freq for extra EU channels (Hz) + + -
Convergence API Version 2.2 P a g e | 30
frequencyEU2 + + -
frequencyIN + + -
frequencyIN2 + + -
frequencyKR UINT center freq for extra KR channels (Hz) + + -
frequencyKR2 + + -
frequencyRU + + -
frequencyRU2 + + -
frequencySubBand UINT frequency sub-band + + -
frequencySubBand2 + + -
fskSYNC + + -
ftsMatchCRCError + + -
ftsVersion + + -
gpsReceiver + + -
joinDelay UINT Rx1 delay in seconds between end of tx and opening of first rx + + - window for join accept message
lbtEnabled + + -
maxDatarate UINT Max datarate for ADR + + -
maxEIRP UINT AS923 max device TX power + + -
maxTxPower UINT maximum tx power + + -
minDatarate UINT Min datarate for ADR + + -
nbDSP + + -
netID STRING LoraWAN network ID : 3 bytes HEX + + -
networkLeadTime + + -
packetForwarderConfig STRING contents to be used for global_conf.json file + + -
packetForwarderMode BOOL enable packet forwarder mode + + -
pingSlotDatarate + + -
pingSlotFreqHop + + -
Convergence API Version 2.2 P a g e | 31
pingSlotFrequency + + -
reducedPacketUpdates + + -
rx1DatarateOffset UINT offset used for datarate on first RX window + + -
rx1Delay UINT Rx1 delay in seconds between end of tx and opening of first rx + + - window
rx2Datarate UINT datarate to be used in second RX window + + -
skipPacketForwarderFieldCheck + + -
spi_device + + -
mqtt OBJECT mqtt settings + + -
enabled BOOL check to enable MQTT protocol + + -
host STRING hostname + + -
password + + -
port UINT port + + -
username + + -
network OBJECT network settings + + -
baseKey STRING Key used for zero touch provisioning : 16 bytes HEX + + -
defaultProfile + + -
eui STRING extended unique identifier + + -
joinServer + + -
key STRING key : 16 bytes HEX + + -
leasetime UINT lease time + + -
lensCheckinInterval + + -
lensDeviceHQ + + -
lensEnabled + + -
lensGatewayStats + + -
lensLocalJoinMetadata + + -
lensNetworkStats + + -
Convergence API Version 2.2 P a g e | 32
lensPacketData + + -
lensPacketMetadata + + -
lensServer + + -
localJoinServerEnabled + + -
name STRING name + + -
passphrase STRING passphrase + + -
public UINT set network mode 0:Private MTS, 1:Public LoRaWAN, 2:Private + + - LoRaWAN
salt STRING Salt used for zero touch provisioning + + -
packetForwarder + + -
aesKey + + -
antennaGain + + -
beaconFreqHop + + -
beaconFrequency + + -
beaconInfoDesc + + -
beaconInterval + + -
beaconLatitude + + -
beaconLongitude + + -
beaconPower + + -
calAD9361 + + -
calTempRoom + + -
channelPlan + + -
diversity + + -
downstreamPort + + -
dspStatInterval + + -
frequencyAS + + -
frequencyAS2 + + -
Convergence API Version 2.2 P a g e | 33
frequencyEU + + -
frequencyEU2 + + -
frequencyIN + + -
frequencyIN2 + + -
frequencyKR + + -
frequencyKR2 + + -
frequencyRU + + -
frequencyRU2 + + -
frequencySubBand + + -
frequencySubBand2 + + -
fskSYNC + + -
ftsMatchCRCError + + -
ftsVersion + + -
fwdCrcDisabled + + -
fwdCrcError + + -
fwdCrcValid + + -
gpsReceiver + + -
gwID + + -
gwID2 + + -
gwSource + + -
keepAliveInterval + + -
lbtDefaultChannels + + -
lbtEnabled + + -
lbtFrequency0 + + -
lbtFrequency1 + + -
lbtFrequency2 + + -
lbtFrequency3 + + -
Convergence API Version 2.2 P a g e | 34
lbtFrequency4 + + -
lbtFrequency5 + + -
lbtFrequency6 + + -
lbtFrequency7 + + -
lbtRssiOffset + + -
lbtRssiTarget + + -
lbtScanTime + + -
manualMode + + -
nbDSP + + -
path + + -
pathGeo + + -
public + + -
pushTimeout + + -
serverAddress + + -
statInterval + + -
upstreamPort + + -
test + + -
disableDutyCycle BOOL disable duty cycle. FOR TESTING PURPOSES ONLY!!! + + -
disableGPS + + -
disableRxJoin1 BOOL disable join downlink packet in first Rx window + + -
disableRxJoin2 BOOL disable join downlink packet in second Rx window + + -
disableRxWindow1 BOOL disable downlink packet in first Rx window + + -
disableRxWindow2 BOOL disable downlink packet in second Rx window + + -
trimInterval + + -
trimRows + + -
udp OBJECT udp settings + + -
allowPublic + + -
Convergence API Version 2.2 P a g e | 35
appPortDown UINT application port down + + -
appPortUp UINT application port up + + -
downstreamPort UINT downstream port + + -
upstreamPort UINT upstream port + + -
whitelist OBJECT white list settings + + -
devices ARRAY local unique appkey store + + -
appeui STRING application id attached to received packets : 8 bytes HEX + + -
appkey STRING device key used to authenticate join request and generate session + + - keys : 16 bytes HEX
class STRING operating class of end-device : A, B or C + + -
deveui STRING device id : 8 bytes HEX + + -
enabled BOOL check to provide an access to the devices from the White List only + + - nat Description: Stores a list of NAT rules for advanced firewall settings : ARRAY
Element Type Description Conv AEP MTR
__v UINT Version of model [2] + + +
chain STRING Chain to apply rule : PREROUTING, or POSTROUTING + + +
description STRING Short description of rule (optional) + + +
dstAddr STRING Destination IP address of packet (optional) + + +
dstInterface STRING Destination interface to apply rule (optional). examples: WAN, + + + LAN, CELLULAR, WIFI, WIFI_AP, ETHERNET
dstMask STRING Destination IP mask (optional). Examples: [255.255.255.0], [24] + + +
dstPort STRING Destination IP port (optional). Examples: [5000], [6000:6002], + + + [5000,6000-6002,8000:8010]
enableNatLoopback BOOL Enables or disables NAT loopback + + +
enabled BOOL Enables or disables this rule + + +
guid STRING Rule ID (automatic) + + +
name STRING Unique name of rule + + +
Convergence API Version 2.2 P a g e | 36
Element Type Description Conv AEP MTR
protocol STRING Specifies the packet protocol (optional). Examples: TCP, UDP, + + + TCP/UDP and ANY'
srcAddr STRING Source IP address of packet (optional) + + +
srcInterface STRING Specifies the source interface to apply rule (optional). Examples: + + + WAN, LAN, CELLULAR, WIFI, WIFI_AP, ETHERNET
srcMac STRING Source MAC address + + +
srcMask STRING Source IP mask of packet (optional). Examples: [255.255.255.0], + + + [24]
srcPort STRING Source IP port (optional). Examples: [5000], [6000:6002], + + + [5000,6000-6002,8000:8010]
target STRING Target of NAT rule: DNAT, SNAT, or MASQUERADE + + +
toAddr STRING Network address translation of IP address + + +
toPort STRING Network address translation of IP ports. Examples: [5000], + + + [6000:6002], [5000,6000-6002,8000:8010] ni Description: Settings for network interfaces : OBJECT
Element Type Description Conv AEP MTR
__v UINT Version of model [2] (automatic) + + -
nis ARRAY A list of configured network interfaces + + -
MAC STRING MAC address of the interface + + -
available BOOL Indicates whether or not the network interface is available + + -
bridge STRING Contains information about connectivity of the network interface + + - to a bridge. If the interface has not connecting it contains '--'
ipv4 OBJECT Contains IPv4 settings + + -
dns1 STRING Specifies the address of primary DNS server + + -
dns2 STRING Specifies the address of secondary DNS server + + -
gateway STRING Specifies the gateway address + + -
ip STRING Specifies the IP address assigned to this interface + + -
mask STRING Specifies the mask assigned to this interface + + -
Convergence API Version 2.2 P a g e | 37
Element Type Description Conv AEP MTR
mode STRING Mode STATIC/DHCP/DHCP-ADDRESSES-ONLY/PPP/PPP- + + - ADDRESSES-ONLY
name STRING Specifies network interface name + + -
nitype STRING Specifies network interface type + + - ETHER/PPP/WIFI_AS_WAN/WIFI_AP/BRIDGE
type STRING Specifies network interface type LAN/WAN + + -
wan_exist BOOL Indicates presence of at least one WAN interface - + - nodeRed Description: Node-RED configuration : OBJECT
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables Node-RED server + + - ovpnTunnels Description: List of configured OpenVPN tunnels : ARRAY
Element Type Description Conv AEP MTR
config STRING The content of OpenVPN configuration file required for + - + establishing OpenVPN connection
enabled BOOL Enable or disable this tunnel. + - +
name STRING OpenVPN tunnel instance name. + - +
type STRING Type of an OpenVPN tunnel. Can be SERVER, CLIENT, CUSTOM. + - + SERVER and CLIENT types are used for the OpenVPN configuration over WebUI. In this case resulting OpenVPN tunnel configuration file (the config field below) is automatically. In case specific user- defined configuration file needs to be applied, the CUSTOM type should be set. policy Description: Contains usage policy settings : OBJECT
Element Type Description Conv AEP MTR
policy STRING Specifies usage policy details + - + powerManagement Description: : NOTE: this is outdated collection and not to be used (do not share).
Convergence API Version 2.2 P a g e | 38
ppp Description: Defines the PPP settings : OBJECT
Element Type Description Conv AEP MTR
authentication OBJECT Specifies the PPP authentication settings + + +
password STRING Specifies the password of the PPP account + + +
type STRING Specifies the type of authentication to use when connecting to + + + PPP: PAP, CHAP or PAP-CHAP (default:'PAP-CHAP')
username STRING Specifies the username of PPP account + + +
connectTimeout UINT Specifies the amount of time in seconds to wait for a connection + + + while in receive mode (default:90)
dialOnDemand BOOL Enables or disables dial on demand : (default:false) + + +
diversity BOOL Enables or disables antenna diversity : (default:true) + + +
enabled BOOL Enables or disables PPP connection : (default:false) + + +
idleTimeout UINT Specifies the amount of time in seconds before a connection is + + + considered idle and is disconnected (default:180)
keepAlive OBJECT Specifies the PPP keep alive settings + + +
dataRecv OBJECT Keeps the PPP connection alive as long as data is being received + + +
enabled BOOL Enables or disables the data receive monitor (default:false) + + +
window UINT Specifies the size of the connection window in minutes (default:0) + + +
enabled BOOL Enables or disables the keep alive feature + + +
hostname STRING Specifies the name of a host that to be used to track connectivity + + +
icmpCount UINT Specifies the number of pings to send (default:4) + + +
pingInterval UINT Specifies the interval to send pings, in seconds (default:60) + + +
radioReboot OBJECT Reboot the radio in addition to restarting pppd after back-off + + -
enabled BOOL Enables or disables radio reboot functionality (default:false) + + -
tcpPort UINT Specifies the connection port on a host (default:0) + + +
type STRING Specifies the method used for keep alive, ICMP or TCP + + + (default:ICMP)
maxRetries UINT Specifies the maximum acceptable number of retries before + + + failure (default:0)
Convergence API Version 2.2 P a g e | 39
Element Type Description Conv AEP MTR
modem OBJECT Specifies the modem settings + + +
apnString STRING Specifies the APN connection string designated by the service + + + provider
baudRate UINT Specifies the baud rate of the modem (default:115200) + + +
commands ARRAY Contains a list of AT commands to send to the modem after a + + + successfully connection
connectString STRING Specifies the string to send to the modem on successful + + + connection (default:'CONNECT')
contextId UINT Specifies context definition id used with AT+CGDCONT + + +
dialNumber STRING Specifies the number the modem should dial for connection + + + (default:'*99***1#')
dialPrefix STRING Specifies the prefix to add to the number being dialed + + + (default:'ATDT')
fwSwitch STRING Specifies a specific firmware image to use on radios embedding 2 + + - different firmware images: '0' for automatic, 'vz' for Verizon, 'att' for AT&T compatible (default:'0')
initStrings ARRAY Contains a list of init strings to send to the modem + + + (default:['AT+CSQ'])
simPin STRING Specifies the PIN used to unlock the SIM + + +
nat BOOL Enables or disables the NAT feature (default:true) + + +
powerOnInitString STRING Specifies the string to send to the radio on boot up + + +
protocol STRING Specifies the protocol to use when connecting to the modem, PPP + - + or WWAN (default:'PPP')
wakeUpOnCall OBJECT Determines the wake-up behavior of radio when a call comes in + + +
ackString STRING Specifies the string used to acknowledge the receipt of an SMS to + + + the delivering SMSC
callerIds ARRAY Contains a list of valid caller IDs for wake-up + + +
action STRING Specifies the action to perform on wake-up + + +
text STRING Specifies the text of a wake-up SMS message or caller-ID value + + +
type STRING Specifies the type of call, CALLER or SMS + + +
Convergence API Version 2.2 P a g e | 40
Element Type Description Conv AEP MTR
delay UINT Specifies the amount of time to wait after call before + + + reconnecting in seconds (default:10)
enabled BOOL Enables or disables the wake-up on call feature (default:false) + + +
fromLan BOOL Enables or disables wake-up on LAN activity (default:false) + + +
initStrings ARRAY Contains a list of cellular radio AT init strings + + +
onCallerId BOOL Enables or disables wake-up on caller ID (default:false) + + +
onRing BOOL Enables or disables wake-up on ring (default:false) + + +
onSms BOOL Enables or disables wake-up on SMS (default:false) + + + radius Description: Configures Radius settings : OBJECT
Element Type Description Conv AEP MTR
acctEnabled BOOL Enables or disables RADIUS accounting (default:false) + - +
acctPort UINT Specifies the primary port for RADIUS accounting and data + - + exchange services (default:1813)
anonymousEnabled BOOL Enables identity privacy so the device will not send + - +
anonymousId STRING Specifies a name or value that the device will use in the identity + - + response when 'Use Anonymous ID' is enabled (default:anonymous)
authEnabled BOOL Enables or disables RADIUS authentication (default:false) + - +
authPort UINT Specifies the primary port for RADIUS authentication service + - + (default:1812)
authType STRING Specifies the protocol that is used to communicate with RADIUS + - + server
checkServer BOOL Enable to validate the server certificate CN (common name) + - + (default:true)
host STRING Specifies the primary RADIUS server + - +
retries UINT Specifies the maximum number of tries to connect to RADIUS + - + server in case of communication failure (default:3)
secondaryAcctPort UINT Specifies the secondary port for RADIUS accounting and data + - + exchange services (default:1813)
Convergence API Version 2.2 P a g e | 41
Element Type Description Conv AEP MTR
secondaryAuthPort UINT Specifies the secondary port for RADIUS authentication service + - + (default:1812)
secondaryHost STRING Specifies the secondary RADIUS server + - +
secret STRING Specifies the shared secret that is used to encrypt packets + - + between RADIUS server and the device
timeout UINT Specifies the interval in seconds between tries to connect to + - + RADIUS server in case of communication failure (default:2) remoteAccess Description: Defines settings for remote access of the device : OBJECT
Element Type Description Conv AEP MTR
bruteForcePrevention OBJECT Settings to configure login attempt throttling + + +
enabled BOOL Enables or disables the ability of the device to throttle username + + + and password combination attempts (default:true)
failAttempts UINT Number of consecutive failures allowed before an account is + + + locked out (default:3)
lockoutSeconds UINT Specifies the amount of time that a user account will be locked + + + out in seconds (default:300)
dosAttackPrevention OBJECT Specifies the settings used to configure new connection throttling + + +
enabled BOOL Enables or disables the ability of the device to throttle the + + + number of new connection attempts (default:true)
limitBurst UINT Specifies the upper limit of new connections allowed per minute + + + (default:100)
limitPerMinute UINT Specifies the average number of new connections allowed per + + + minute (default:60)
http OBJECT Settings to configure HTTP access to the device + + +
enabled BOOL Enables or disables HTTP access (default:true) + + +
lan BOOL Enables or disables HTTP access for LAN traffic (default:true) + + +
port UINT Specifies the HTTP port (default:80) + + +
redirectToHttps BOOL Enables or disables redirect request for an HTTP port to an HTTPS + + + port (default:true)
wan BOOL Enables or disables HTTP access for WAN traffic (default:false) + + +
Convergence API Version 2.2 P a g e | 42
Element Type Description Conv AEP MTR
https OBJECT Settings to configure HTTPS access to the device + + +
enabled BOOL Enables or disables HTTPS access (default:true) + + +
lan BOOL Enables or disables HTTPS access for LAN traffic (default:true) + + +
port UINT Specifies the port used for the device configuration website + + + (default:443)
wan BOOL Enables or disables HTTPS access for WAN traffic (default:false) + + +
icmp OBJECT Settings to configure ICMP access to the device + + +
enabled BOOL Enables or disables device response to ICMP traffic (default:true) + + +
respondToLan BOOL Enables or disables the device response to LAN ICMP traffic + + + (default:true)
respondToWan BOOL Enables or disables the device response to WAN ICMP traffic + + + (default:false)
modbusSlave OBJECT Specifies the settings for configuring a Modbus Query Server + - +
enabled BOOL Enables or disables Modbus (default:false) + - +
lan BOOL Enables or disables Modbus access from local area network + - + (default:true)
port UINT Specifies the port used for Modbus (default:1502) + - +
nodeRed OBJECT Settings to configure access to the Node-RED server + + -
lan BOOL Enables or disables Node-RED access from local area network + + - (default:true)
wan BOOL Enables or disables Node-RED access from WAN (default:false) + + -
pingLimit OBJECT Settings used to configure ICMP throttling + + +
enabled BOOL Enables or disables device’s ability to throttle the number of ICMP + + + packets to the device (default:true)
limitBurst UINT Specifies the upper limit of ICMP packets allowed per second + + + (default:30)
limitPerSecond UINT Specifies the average number of new connections allowed per + + + second (default:10)
privateWan BOOL Enables dropping packets with private source addresses coming + + + from public WAN interfaces to prevent spoofed packets (default:false)
Convergence API Version 2.2 P a g e | 43
Element Type Description Conv AEP MTR
snmp OBJECT Settings to configure SNMP access to device + - +
lan BOOL Enables or disables SNMP access via LAN (default:true) + - +
wan BOOL Enables or disables SNMP access via WAN (default:false) + - +
ssh OBJECT Settings to configure SSH access to the device + + +
enabled BOOL Enables or disables SSH access to the device (default:false) + + +
lan BOOL Enables or disables SSH access from a LAN (default:false) + + +
port UINT Port used for SSH access to the device (default:22) + + +
wan BOOL Enables or disables SSH access from a WAN (default:false) + + +
timeoutSeconds UINT Specifies the amount of time before remote access disconnects + + + due to inactivity in seconds (default:300)
__v - + - remoteManagement Description: remote management settings : OBJECT
Element Type Description Conv AEP MTR
accountKey STRING account key registered to user by remote management platform + + +
allowConfigurationUpgrade BOOL allow configuration upgrades to be managed through remote + + + management platform (default:true)
allowConfigurationUpload BOOL allow the device configuration to be uploaded to remote + + - management platform (default:true)
allowFirmwareUpgrade BOOL allow firmware upgrades to be managed through remote + + + management platform (default:true)
allowRadioFirmwareUpgrade BOOL allow radio firmware upgrades to be managed through remote + + + management platform (default:true)
enabled BOOL enable the device to be managed by a remote management + + + platform (default:false)
gpsDataInterval UINT set the gps push interval in seconds (default:43200) + + +
queryServerInterval UINT set the check-in interval in seconds (default:43200) + + +
serverName STRING remote management platform's url or IP address + + + (default:ds.multitech.com)
Convergence API Version 2.2 P a g e | 44
Element Type Description Conv AEP MTR
serverPort UINT remote management platform's IP port (default:5798) + + +
sslEnabled BOOL enable traffic encryption (default:true) + + +
syncWithDialOnDemand BOOL only allow the device to contact the remote management + + + platform when the Cellular link is already up (default:false) routes Description: Stores a list of static routes : ARRAY
Element Type Description Conv AEP MTR
gateway STRING Specifies the route’s default gateway + + +
ip STRING Specifies the route’s IP address + + +
mask UINT Specifies the route’s network mask (0-32) + + +
name STRING route name + + + secureProtocols Description: Cipher suites and advanced security options : ARRAY
Element Type Description Conv AEP MTR
cipher STRING List of ciphers enabled for the component + - +
cipherAvailable STRING List of allowed ciphers available for the secure component + - +
cipherSuite STRING List of cipher suites enabled for the component + - +
cipherSuiteAvailable STRING List of allowed cipher suites available for the secure component + - +
client OBJECT Set client authentication mechanism + - -
verify BOOL Enables or disables Client Authentication. When enabled the web + - - server will authenticate the client using the client’s public key certificate (default:false)
mac STRING List of MACs enabled for the component + - +
macAvailable STRING List of allowed MACs available for the secure component + - +
name STRING Name of the component that uses the instance + - +
protocol OBJECT Set of secure protocols + - +
tls1_1 BOOL Enables or disables TLSv1.1 (default:false) + - +
Convergence API Version 2.2 P a g e | 45
Element Type Description Conv AEP MTR
tls1_2 BOOL Enables or disables TLSv1.2 (default:true) + - +
type STRING Type of secure library that is used for implementation secure + - + connection. For example: openssl or openssh selfDiagnostic Description: Self-diagnostic settings : OBJECT
Element Type Description Conv AEP MTR
flashMemoryViolation OBJECT Contains flash memory violation settings + - +
disableUserFirewallRules BOOL Specifies whether disable user-defined firewall rules + - +
disableWans BOOL Specifies whether disable WAN interfaces + - +
enabled BOOL Enables or disables flash memory monitoring (default:false) + - +
interval UINT Specifies the flash memory check interval in hours (default:24) + - +
resourceOveruse OBJECT Contains resource overuse settings + - +
enabled BOOL Enables or disables resource overuse monitoring (default:false) + - +
rebootDevice BOOL Specifies whether reboot the device device + - +
securityViolation OBJECT Contains security violation settings + - +
disableUserFirewallRules BOOL Specifies whether disable user-defined firewall rules + - +
disableWans BOOL Specifies whether disable WAN interfaces + - +
enabled BOOL Enables or disables enable security violation monitoring + - + (default:false) serial Description: Defines the serial port settings : OBJECT
Element Type Description Conv AEP MTR
baudRate UINT Specifies the serial baud rate (default:115200) + + +
dataBits UINT Specifies the expected number of data bits (default:8) + + +
flowControl STRING Specifies the expected flow control convention, RTS-CTS or NONE + + + (default:NONE)
modbus BOOL Enables or disables modbus (default:false) + + +
Convergence API Version 2.2 P a g e | 46
Element Type Description Conv AEP MTR
parity STRING Specifies the parity convention, ODD, EVEN or NONE + + + (default:NONE)
stopBits UINT Specifies the expected number of stop bits (default:1) + + +
type STRING If the device supports a flexible serial port, specifies the type of + + + serial port: RS-232, RS-422, or RS-485 (default:RS-232) serialModemPassthrough Description: Defines serial modem mode settings : OBJECT
Element Type Description Conv AEP MTR
baudRate UINT Specifies the serial baud rate (default:115200) + - +
dataBits UINT Specifies the expected number of data bits (default:8) + - +
flowControl STRING Specifies the expected flow control convention, RTS-CTS or NONE + - + (default:NONE)
parity STRING Specifies the parity convention, ODD, EVEN or NONE + - + (default:NONE)
stopBits UINT Specifies the expected number of stop bits (default:1) + - + sms Description: Defines the SMS settings : OBJECT
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables SMS service on the device (default:false) + + +
inbox Contains a list of received SMS messages: ARRAY + + +
outbox Contains a list of sent SMS messages: ARRAY + + +
receivedLimit UINT Specifies the number of received SMS to keep. Set this element to + + + 0 if you do not want to keep SMS messages. (0-1000, default:1000)
resendLimit UINT Specifies the number of times the modem retries sending a failed + + + SMS message. Set this element to 0 if you do not want to resend failed SMS messages. (0-10, default:0)
sentLimit UINT Specifies the number of sent SMS messages to keep. Set this + + + element to 0 if you do not want to keep SMS messages. (0-1000, default:1000)
smsCommands OBJECT Available SMS commands + + +
Convergence API Version 2.2 P a g e | 47
Element Type Description Conv AEP MTR
apnEnabled BOOL Enable or disable control of getting of APN value using SMS + + + service (default:false)
cellularStatusEnabled BOOL Enable or disable control of getting of cellular status using SMS + + + service (default:false)
checkinEnabled BOOL Enable or disable control of checkin process using SMS service + + + (default:false)
enabled BOOL Enable or disable SMS commands functionality (default:false) + + +
ethernetEnabled BOOL Enable or disable control of getting of ethernet status using SMS + + + service (default:false)
geopositionEnabled BOOL Enable or disable control of getting the device coordinates + + + obtained from GPS using SMS service (default:false)
lnsRestartEnabled BOOL Enable or disable control of restart of LoRa Services using SMS + + - service (default:false)
password OBJECT Settings for SMS commands password + + +
customText STRING Custom password text (default:'') + + +
enabled BOOL Enable or disable password usage in SMS commands + + + (default:true)
text STRING Custom password + + +
useCustomPassword BOOL Enable or disable custom password usage in SMS commands + + + (default:true)
pingEnabled BOOL Enable or disable control of ping command using SMS service + + + (default:false)
radioEnabled BOOL Enable or disable control of getting of radio status using SMS + + + service (default:false)
rebootEnabled BOOL Enable or disable control of reboot of device using SMS service + + + (default:false)
rmEnabled BOOL Enable or disable control of remote management using SMS + + + service (default:false)
serialEnabled BOOL Enable or disable control of getting of serial port status using SMS + + + service (default:false)
setCellularEnabled BOOL Enable or disable control of cellular connection using SMS service + + + (default:false)
Convergence API Version 2.2 P a g e | 48
Element Type Description Conv AEP MTR
wanStatusEnabled BOOL Enable or disable control of getting of WAN status using SMS + + + service (default:false)
whitelist OBJECT Defines settings for SMS commands whitelist + + +
enabled BOOL Enable or disable whitelist usage in SMS commands (default:true) + + +
numbers A list of phone numbers in the whitelist + + +
wifiEnabled BOOL Enable or disable control of getting the Wi-Fi status using SMS + + + service (default:false)
geoposition BOOL enable or disable control of getting device coordinates obtained - + + from GPS using SMS service (default:false) smtp Description: Defines the SMTP settings : OBJECT
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables SMTP, which allows the device to send email + + + messages (default:false)
maxNumberOfEntries STRING Specifies the number of mail log entries kept for completed + + + emails in the device. (10-1000)
password STRING Specifies the SMTP password + + +
serverAddress STRING Specifies the SMTP server’s address + + +
serverPort STRING Specifies the SMTP server’s port number + + +
sourceEmailAddress STRING Specifies the device email address. This address is displayed as the + + + From address in a sent email.
username STRING Specifies the SMTP username + + + snmp Description: Defines the SNMP settings : OBJECT
Element Type Description Conv AEP MTR
__v UINT Version of model. Must be set to 2 + - +
server OBJECT Defines SNMP server settings + - +
allowedAddresses ARRAY A list of allowed IP addresses array (valid for v1/v2c server only) + - +
address STRING Specifies an allowed IP address (in the ###.###.###.### format) + - +
Convergence API Version 2.2 P a g e | 49
Element Type Description Conv AEP MTR
prefix STRING Specifies the network prefix, e.g. 16, 24 or 32 + - +
enabled BOOL Enable or disable SNMP server + - +
users ARRAY A list of configured SNMP server users + - +
authPass STRING Specifies the authentication password (SNMPv3) + - +
authProto STRING Specifies the authentication protocol (MD5, SHA1 or empty) used + - + for authentication of SNMPv3 clients
community STRING Specifies the read-only community string used for authentication + - + of SNMP v1/v2c clients
enabled BOOL Enables or disables the SNMP server user + - +
label STRING Specifies the unique configuration entry name + - +
privPass STRING Specifies the encryption password (SNMPv3) + - +
privProto STRING Specifies the encryption protocol (DES, AES-128 or empty) used + - + for encryption of SNMPv3 messages
username STRING Specifies the username used to authenticate SNMPv3 client + - +
version STRING Specifies SNMP server user version (v1/v2c or v3) + - +
traps OBJECT Defines SNMP Trap destinations + - +
enabled BOOL Enables or disables SNMP traps delivery + - +
engineId STRING Specifies the authoritative Engine ID is a unique identifier used by + - + remote SNMP Trap servers to distinguish received SNMP traps (hex number between 5 and 32 octets long, e.g. 0x0102030405.)
engineIdDefault STRING Specifies the default value of Authoritative Engine ID generated + - + automatically (read-only)
receivers ARRAY A list of configured SNMP trap destinations + - +
address STRING Specifies IP address or remote SNMP Trap server (in the + - + ###.###.###.### format)
authPass STRING Specifies the authentication Password (SNMPv3) + - +
authProto STRING Specifies eth authentication protocol (MD5, SHA1 or empty) used + - + for authentication of SNMPv3 traps
community STRING Specifies the community string used for authentication of SNMP + - + v1/v2c traps
Convergence API Version 2.2 P a g e | 50
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables the SNMP trap destination + - +
label STRING Specifies the unique configuration entry name + - +
privPass STRING Specifies encryption password (SNMPv3) + - +
privProto STRING Specifies encryption protocol (DES, AES-128 or empty) used for + - + encryption of SNMPv3 traps
username STRING Specifies the username used for authentication on remote + - + SNMPv3 trap server
version STRING SNMP traps version (v1, v2c or v3) + - + sntp Description: Defines the clock synchronization settings with a remote SNTP server : OBJECT
Element Type Description Conv AEP MTR
enabled BOOL Enable or disable SNTP client (default:false) + + +
pollingTime UINT Frequency in minutes to poll current time (default:120) [0-1440] + + +
servers ARRAY list of IP addresses or domain names of SNTP servers + + -
timeZone STRING Zoneinfo file path to use as timezone (default:UTC) + + +
timeZones ARRAY Specifies the list of all known timezones + + -
server STRING ip address or domian name of server - - + stats Description: statistics on services and interfaces : OBJECT
Element Type Description Conv AEP MTR
dns ARRAY current DNS server IP addresses + + +
servers ARRAY A list of DNS servers available for domain name resolution + + +
dhcpLease ARRAY array of dns servers issued to dhcp clients with lease - + +
eth0 OBJECT Current statistics on Ethernet interface + + -
flags OBJECT Various network interface flags + + -
all_multi BOOL Receives all multicast packets + + -
broadcast BOOL Broadcast address valid + + -
Convergence API Version 2.2 P a g e | 51
Element Type Description Conv AEP MTR
dynamic BOOL The addresses are lost when the interface goes down + + -
loopback BOOL The interface is a loopback net + + -
lower_up BOOL Driver signals L1 up + + -
multicast BOOL Supports multicast. + + -
no_arp BOOL No address resolution protocol + + -
point_to_point BOOL Interface is point-to-point link + + -
promisc BOOL Interface is in promiscuous mode + + -
up BOOL The interface is up + + -
ip STRING Specifies the IP address assigned to this interface + + -
mask STRING Specifies the mask assigned to this interface + + -
mtu STRING Specifies maximum transmission unit in bytes + + -
rx OBJECT Contains statistics on received bytes + + -
bytes STRING Specifies the number of received bytes + + -
dropped STRING Specifies the number of received byte drops + + -
errors STRING Specifies the number of received byte errors + + -
frame STRING Specifies the number of received frames + + -
overruns STRING Specifies the number of received overruns + + -
packets STRING Specifies the number of received packets + + -
tx OBJECT Contains statistics on transmitted bytes + + -
bytes STRING Specifies the number of transmitted bytes + + -
carrier STRING Specifies the number of transmitted carriers + + -
collisions STRING Specifies the number of transmitted collisions + + -
dropped STRING Specifies the number of transmitted drops + + -
errors STRING Specifies the number of transmitted errors + + -
overruns STRING Specifies the number of transmitted overruns + + -
packets STRING Specifies the number of transmitted packets + + -
Convergence API Version 2.2 P a g e | 52
Element Type Description Conv AEP MTR
queueLength STRING Specifies the number of packets that can be queued for + + - transmission
eth0History ARRAY Specifies daily statistics on Ethernet interface traffic + + -
date UINT Specifies the time stamp in seconds + + -
todayRx UINT Specifies the number of received bytes for a day + + -
todayTx UINT Specifies the number of transmitted bytes for a day + + -
eth0Total OBJECT Total and today’s statistics on Ethernet interface traffic + + -
todayRx UINT Specifies the number of bytes received during the pre-determined + + - period
todayTx UINT Specifies the number of bytes transmitted during the pre- + + - determined period
totalRx UINT Specifies the number of bytes received today + + -
totalTx UINT Specifies the number of bytes transmitted today + + -
eth1 OBJECT Current statistics on Ethernet interface + + -
flags OBJECT Various network interface flags + + -
all_multi BOOL Receives all multicast packets + + -
broadcast BOOL Broadcast address valid + + -
dynamic BOOL The addresses are lost when the interface goes down + + -
loopback BOOL The interface is a loopback net + + -
lower_up BOOL Driver signals L1 up + + -
multicast BOOL Supports multicast. + + -
no_arp BOOL No address resolution protocol + + -
point_to_point BOOL Interface is point-to-point link + + -
promisc BOOL Interface is in promiscuous mode + + -
up BOOL The interface is up + + -
ip STRING Specifies the IP address assigned to this interface + + -
mask STRING Specifies the mask assigned to this interface + + -
Convergence API Version 2.2 P a g e | 53
Element Type Description Conv AEP MTR
mtu STRING Specifies maximum transmission unit in bytes + + -
rx OBJECT Contains statistics on received bytes + + -
bytes STRING Specifies the number of received bytes + + -
dropped STRING Specifies the number of received byte drops + + -
errors STRING Specifies the number of received byte errors + + -
frame STRING Specifies the number of received frames + + -
overruns STRING Specifies the number of received overruns + + -
packets STRING Specifies the number of received packets + + -
tx OBJECT Contains statistics on transmitted bytes + + -
bytes STRING Specifies the number of transmitted bytes + + -
carrier STRING Specifies the number of transmitted carriers + + -
collisions STRING Specifies the number of transmitted collisions + + -
dropped STRING Specifies the number of transmitted drops + + -
errors STRING Specifies the number of transmitted errors + + -
overruns STRING Specifies the number of transmitted overruns + + -
packets STRING Specifies the number of transmitted packets + + -
queueLength STRING Specifies the number of packets that can be queued for + + - transmission
eth1History ARRAY Specifies daily statistics on Ethernet interface traffic + + -
date UINT Specifies the time stamp in seconds + + -
todayRx UINT Specifies the number of received bytes for a day + + -
todayTx UINT Specifies the number of transmitted bytes for a day + + -
eth1Total OBJECT Total and today’s statistics on Ethernet interface traffic + + -
todayRx UINT Specifies the number of bytes received during the pre-determined + + - period
todayTx UINT Specifies the number of bytes transmitted during the pre- + + - determined period
Convergence API Version 2.2 P a g e | 54
Element Type Description Conv AEP MTR
totalRx UINT Specifies the number of bytes received today + + -
totalTx UINT Specifies the number of bytes transmitted today + + -
eth2 OBJECT Current statistics on Ethernet interface + + -
flags OBJECT Various network interface flags + + -
all_multi BOOL Receives all multicast packets + + -
broadcast BOOL Broadcast address valid + + -
dynamic BOOL The addresses are lost when the interface goes down + + -
loopback BOOL The interface is a loopback net + + -
lower_up BOOL Driver signals L1 up + + -
multicast BOOL Supports multicast + + -
no_arp BOOL No address resolution protocol + + -
point_to_point BOOL Interface is point-to-point link + + -
promisc BOOL Interface is in promiscuous mode + + -
up BOOL The interface is up + + -
ip STRING Specifies the IP address assigned to this interface + + -
mask STRING Specifies the mask assigned to this interface + + -
mtu STRING Specifies maximum transmission unit in bytes + + -
rx OBJECT Contains statistics on received bytes + + -
bytes STRING Specifies the number of received bytes + + -
dropped STRING Specifies the number of received byte drops + + -
errors STRING Specifies the number of received byte errors + + -
frame STRING Specifies the number of received frames + + -
overruns STRING Specifies the number of received overruns + + -
packets STRING Specifies the number of received packets + + -
tx OBJECT Contains statistics on transmitted bytes + + -
bytes STRING Specifies the number of transmitted bytes + + -
Convergence API Version 2.2 P a g e | 55
Element Type Description Conv AEP MTR
carrier STRING Specifies the number of transmitted carriers + + -
collisions STRING Specifies the number of transmitted collisions + + -
dropped STRING Specifies the number of transmitted drops + + -
errors STRING Specifies the number of transmitted errors + + -
overruns STRING Specifies the number of transmitted overruns + + -
packets STRING Specifies the number of transmitted packets + + -
queueLength STRING Specifies the number of packets that can be queued for + + - transmission
eth2History ARRAY Specifies daily statistics on Ethernet interface traffic + + -
date UINT Specifies the time stamp in seconds + + -
todayRx UINT Specifies the number of received bytes for a day + + -
todayTx UINT Specifies the number of transmitted bytes for a day + + -
eth2Total OBJECT Total and today’s statistics on Ethernet interface traffic + + -
todayRx UINT Specifies the number of bytes received during the pre-determined + + - period
todayTx UINT Specifies the number of bytes transmitted during the pre- + + - determined period
totalRx UINT Specifies the number of bytes received today + + -
totalTx UINT Specifies the number of bytes transmitted today + + -
gps OBJECT Contains positional information of gps device + + +
alt STRING Specifies altitude + + +
fix INT Fix quality (0=No fix, 1=Have fix without DGPS, 2 = have fix with + + + DGPS)
lat DOUBLE Specifies latitude coordinate + + +
lng DOUBLE Specifies longitude coordinate + + +
sats INT Number of satellites used in solution + + +
time DOUBLE Time of update + + +
Convergence API Version 2.2 P a g e | 56
Element Type Description Conv AEP MTR
data a list of NMEA data strings containing latest gps information: - + + ARRAY
gre OBJECT Contains statistics on gre tunnels (keys are tunnel names) + + +
tunnel OBJECT Statistics on ipsec LAN interface transmitted bytes + + +
localIp STRING Specifies the IP address assigned to this interface + + +
mode STRING Specifies tunnel mode + + +
remoteIp STRING Specifies the IP address of the remote end of this tunnel + + +
rx OBJECT Summarizes receiver statistics + + +
Mcasts UINT Specifies the total number of multicast packets received on a + + + broadcast GRE tunnel
bytes UINT Specifies the total number of bytes received on the interface + + +
csumErrors UINT Specifies the total number of packets dropped because of + + + checksum failures for a GRE tunnel with checksumming enabled.
errors UINT Specifies the total number of receiver errors + + +
outOfSequence UINT Specifies the total number of packets dropped because they + + + arrived out of sequence for a GRE tunnel with serialization enabled
packets UINT Specifies the total number of packets received on the interface + + +
ttl STRING Specifies time to live set on the interface + + +
tx OBJECT Summarizes transmitter statistics + + +
bytes UINT Specifies the total number of bytes transmitted on the interface + + +
deadLoop UINT Specifies the total number of packets which were not transmitted + + + because the tunnel is looped back to itself
errors UINT Specifies the total number of transmitter errors + + +
noBuffs UINT Specifies the total number of packets which were not transmitted + + + because the kernel failed to allocate a buffer
noRoute UINT Specifies the total number of packets which were not transmitted + + + because there is no IP route to the remote endpoint
packets UINT Specifies the total number of packets transmitted on the interface + + +
ipsec ARRAY Statistics on IPSec tunnels + + +
Convergence API Version 2.2 P a g e | 57
Element Type Description Conv AEP MTR
name STRING Specifies an IPSec tunnel name + - -
rxBytes UINT Specifies the number of received bytes + - -
rxPackets UINT Specifies the number of received packets + - -
tunnelName STRING Specifies IPSec endpoints in ###.###.###.### - ###.###.###.### + - - format
txBytes UINT Specifies the number of transmitted bytes + - -
txPackets UINT Specifies the number of transmitted packets + - -
ipsec0 OBJECT statistics on ipsec lan interface - + +
ip STRING the ip address assigned to this interface - + +
mtu STRING maximum transmission unit in bytes - + +
rx OBJECT statistics on ipsec lan interface received bytes - + +
bytes STRING number of received bytes - + +
dropped STRING number of received byte drops - + +
errors STRING number of received byte errors - + +
frame STRING number of received frames - + +
overruns STRING number of received overruns - + +
packets STRING number of received packets - + +
tx OBJECT statistics on ipsec lan interface transmitted bytes - + +
bytes STRING number of transmitted bytes - + +
carrier STRING number of transmitted carriers - + +
collisions STRING number of transmitted collisions - + +
dropped STRING number of transmitted drops - + +
errors STRING number of transmitted errors - + +
overruns STRING number of transmitted overruns - + +
packets STRING number of transmitted packets - + +
queueLength STRING number of packets that can be queued for transmission - + +
Convergence API Version 2.2 P a g e | 58
Element Type Description Conv AEP MTR
ipsec1 OBJECT statistics on ipsec wan interface - + +
ip STRING the ip address assigned to this interface - + +
mtu STRING maximum transmission unit in bytes - + +
rx OBJECT statistics on ipsec lan interface received bytes - + +
bytes STRING number of received bytes - + +
dropped STRING number of received byte drops - + +
errors STRING number of received byte errors - + +
frame STRING number of received frames - + +
overruns STRING number of received overruns - + +
packets STRING number of received packets - + +
tx OBJECT statistics on ipsec lan interface transmitted bytes - + +
bytes STRING number of transmitted bytes - + +
carrier STRING number of transmitted carriers - + +
collisions STRING number of transmitted collisions - + +
dropped STRING number of transmitted drops - + +
errors STRING number of transmitted errors - + +
overruns STRING number of transmitted overruns - + +
packets STRING number of transmitted packets - + +
queueLength STRING number of packets that can be queued for transmission - + +
lan0 OBJECT Current statistics on the bridge interface + + -
ip STRING Specifies the IP address assigned to this interface + + -
mask STRING Specifies the mask assigned to this interface + - -
mtu STRING Specifies maximum transmission unit in bytes + + -
rx OBJECT Contains statistics on received bytes + + -
bytes STRING Specifies the number of received bytes + + -
dropped STRING Specifies the number of received byte drops + + -
Convergence API Version 2.2 P a g e | 59
Element Type Description Conv AEP MTR
errors STRING Specifies the number of received byte errors + + -
frame STRING Specifies the number of received frames + + -
overruns STRING Specifies the number of received overruns + + -
packets STRING Specifies the number of received packets + + -
tx OBJECT Contains statistics on transmitted bytes + + -
bytes STRING Specifies the number of transmitted bytes + + -
carrier STRING Specifies the number of transmitted carriers + + -
collisions STRING Specifies the number of transmitted collisions + + -
dropped STRING Specifies the number of transmitted drops + + -
errors STRING Specifies the number of transmitted errors + + -
overruns STRING Specifies the number of transmitted overruns + + -
packets STRING Specifies the number of transmitted packets + + -
queueLength STRING Specifies the number of packets that can be queued for + + - transmission
modbus ARRAY Statistics on modbus passthrough pipe + - +
id UINT Specifies the ID of the device on the bus + - +
rx UINT Reports the number of bytes received by the device + - +
status STRING Reports the status of the device + - +
time UINT Reports the number of seconds since the last activity + - +
tx UINT Reports the number of bytes transmitted by the device + - +
ovpn ARRAY Statistics on OpenVPN tunnels + - -
connected BOOL Indicates whether the tunnel is established + - -
dev STRING Indicates the type of virtual networking interface (tun or tap) + - -
name STRING Indicates the name of the tunnel + - -
proto STRING Indicates the protocol to use when connecting with the remote + - - (tcp or udp)
statistics OBJECT Contains statistics on received/transmitted bytes + - -
Convergence API Version 2.2 P a g e | 60
Element Type Description Conv AEP MTR
rx UINT Specifies the number of received bytes + - -
tx UINT Specifies the number of transmitted bytes: UINT + - -
type STRING Indicates whether the tunnel is configured as a client or as a + - - server
use_static BOOL Specifies whether a static key is used for authorization + - -
ppp OBJECT Contains statistics for the PPP interface + + +
areaCode STRING Reports localization area code + + +
dnsServers ARRAY A list of strings representing IP addresses of DNS servers + + +
flags OBJECT Various network interface flags + - -
all_multi BOOL Receives all multicast packets + - -
broadcast BOOL Broadcast address valid + - -
dynamic BOOL The addresses are lost when the interface goes down + - -
loopback BOOL The interface is a loopback net + - -
lower_up BOOL Driver signals L1 up + - -
multicast BOOL Supports multicast. + - -
no_arp BOOL No address resolution protocol + - -
point_to_point BOOL Interface is point-to-point link + - -
promisc BOOL Interface is in promiscuous mode + - -
up BOOL The interface is up + - -
ip STRING Reports the IP address assigned to this interface + + +
link STRING Reports status of the link + + +
localIp STRING Reports the IP address assigned to this interface + + +
localIp6 STRING Reports the IPv6 address assigned to this interface + - -
mtu STRING Reports maximum transmission unit in bytes + + +
number STRING Reports cellular module's phone number + + +
remoteIp STRING Reports the externally facing IP address of this interface + + +
Convergence API Version 2.2 P a g e | 61
Element Type Description Conv AEP MTR
remoteIp6 STRING Reports the externally facing IPv6 address of this interface + - -
roaming BOOL indicates whether or not this connection is considered roaming + + +
rssi STRING Reports Received Signal Strength Indication value [0-31] + + +
rssiDbm STRING Specifies the received signal strength indication in dBm + - -
rx OBJECT Contains statistics on received bytes + + +
bytes STRING Specifies the number of received bytes + + +
dropped STRING Specifies the number of received byte drops + + +
errors STRING Specifies the number of received byte errors + + +
frame STRING Specifies the number of received frames + + +
overruns STRING Specifies the number of received overruns + + +
packets STRING Specifies the number of received packets + + +
tower STRING Reports cellular tower ID + + +
tx OBJECT Contains statistics on transmitted bytes + + +
bytes STRING Specifies the number of transmitted bytes + + +
carrier STRING Specifies the number of transmitted carriers + + +
collisions STRING Specifies the number of transmitted collisions + + +
dropped STRING Specifies the number of transmitted drops + + +
errors STRING Specifies the number of transmitted errors + + +
overruns STRING Specifies the number of transmitted overruns + + +
packets STRING Specifies the number of transmitted packets + + +
queueLength STRING Specifies the number of packets that can be queued for + + + transmission
uptime UINT Reports number of minutes connection has been established + + +
pppHistory ARRAY Specifies daily statistics on PPP interface traffic + + +
date UINT Specifies the time stamp in seconds + + +
todayRx UINT Specifies the number of received bytes for a day + + +
Convergence API Version 2.2 P a g e | 62
Element Type Description Conv AEP MTR
todayTx UINT Specifies the number of transmitted bytes for a day + + +
pppTotal OBJECT Total and today’s statistics on PPP interface traffic + + +
todayRx UINT Specifies the number of bytes received during the pre-determined + + + period
todayTx UINT Specifies the number of bytes transmitted during the pre- + + + determined period
totalRx UINT Specifies the number of bytes received today + + +
totalTx UINT Specifies the number of bytes transmitted today + + +
radio OBJECT Reports statistics and information about the cellular radio + + +
abnd STRING Reports the current active band + - -
carrier STRING Designates the cellular service provider (home network) + + +
channel STRING Specifies the ARFCN or UARFCN Assigned Radio Channel + + +
cid STRING Specifies the cellular ID in hexadecimal + + +
code STRING Specifies the MTS short model code: (H5, H6, or G3) + + +
debug OBJECT Contains detailed information about the radio’s current status + + + (information may vary between radio types)
bler STRING Reports the block error rate (percentage) + + +
drx STRING Reports the discontinuous reception cycle length in milliseconds + + +
ecio STRING Reports the active Ec/Io (chip energy per total wideband power in + + + dBm)
mm STRING Reports the mobility management state + + +
nom STRING Reports the current network operator mode + + +
psc STRING Reports the primary synchronization code + + +
rr STRING Reports the radio resource state + + +
rscp STRING Reports the active RSCP (Received Signal Code Power in dBm) + + +
sd STRING Reports the service domain + + +
txpwr STRING Reports the transmit power + + +
abnd STRING Active Band - + +
Convergence API Version 2.2 P a g e | 63
Element Type Description Conv AEP MTR
firmware STRING Reports the radio firmware version + + +
firmwarebuild STRING Reports the radio firmware build number + - -
hardware STRING Reports the radio hardware revision + + +
iccid STRING Reports the integrated circuit card identifier (Not available for + + + CMDA)
imsi STRING Reports the radio IMEI number + + +
lac STRING Reports the location area code in hexadecimal + + +
manufacturer STRING Reports the radio manufacturer + + +
mcc STRING Reports the mobile country code + + +
mdn STRING Reports the mobile directory number (CDMA Only) + + +
meid STRING Reports the mobile equipment identifier (CDMA Only) + + +
mipProfile OBJECT Specifies the mobile IP configuration (CDMA Only) + + +
enabled BOOL Indicates if profile is active or not + + +
homeAddress STRING Specifies the home address + + +
id UINT Specifies the MIP profile ID + + +
mnAaaSpi STRING Specifies the mobile node authentication, authorization, and + + + accounting server security parameter index
mnAaaSs Indicates whether the mobile node authentication, authorization, + + + and accounting server shared secret is set: BOOL
mnHaSpi STRING Specifies the mobile node home agent security server parameter + + + index
mnHaSs BOOL Indicates whether the mobile node home agent security server + + + shared secret is set
nai STRING Specifies the network access identifier + + +
primaryHa STRING Specifies the primary home agent + + +
revTun BOOL Indicates whether reverse tunneling is enabled + + +
secondaryHa STRING Specifies the secondary home agent + + +
mnc STRING Specifies the mobile network (operator) code + + +
Convergence API Version 2.2 P a g e | 64
Element Type Description Conv AEP MTR
model STRING Specifies the radio model [HE910-D, HE910-EUD, GE910, DE910, + + + CE910, ...]
msid STRING Specifies the mobile station ID (also known as MIN or MSIN) + + +
network STRING Reports the current cellular service provider (Not available for + + + CDMA)
provisioned BOOL Reports whether or not the radio has been activated with a data + + + account (CDMA only)
rac STRING Reports the routing area code in hexadecimal + + +
roaming BOOL Indicates whether or not the radio is using the home network + + +
rssi UINT Specifies the received signal strength indication + + +
rssidBm STRING Specifies the received signal strength indication in dBm + + +
service STRING Specifies the service connection type [GPRS, EGPRS, WCDMA, + + + HSDPA]
type STRING Specifies the radio technology category [GSM, CDMA, LTE] + + +
serial OBJECT Reports statistics and information about the serial interface + + +
dcd STRING Reports status of data carrier detect line + + +
rx UINT Reports number of bytes received on serial interface + + +
tx UINT Reports number of bytes transmitted on serial interface + + +
service OBJECT Various service status + + +
ddns OBJECT Displays the status of DDNS services + + +
enabled BOOL Indicates whether the DDNS service is on + + +
status STRING Displays the status of DDNS + + +
dialOnDemand OBJECT Displays the status of the dial-on-demand services + + +
enabled BOOL Indicates whether the dial-on-demand service is on + + +
status STRING Displays the status of dial-on-demand + + +
failover OBJECT Displays the status of WAN failover services + - -
enabled BOOL Indicates whether the WAN failover service is on + - -
status STRING Displays the status of WAN failover + - -
Convergence API Version 2.2 P a g e | 65
Element Type Description Conv AEP MTR
keepAlive OBJECT Displays the status of the keep-alive services + + +
enabled BOOL Indicates whether the keep-alive service is on + + +
status STRING Displays the status of keep-alive + + +
sms OBJECT Displays the status of the SMS service + - -
enabled BOOL Indicates whether the SMS service is on + - -
status STRING Displays the status of SMS service + - -
smtp OBJECT Displays the status of the SMTP service + - -
enabled BOOL Indicates whether the SMTP service is on + - -
status STRING Displays the status of SMTP service + - -
sntp OBJECT Displays the status of the SNTP services + + +
enabled BOOL Indicates whether the SNTP service is on + + +
status STRING Displays the status of SNTP service + + +
status ARRAY Contains a list of important system events + + +
guid STRING Specifies unique traceable identifier of the event source + + +
msg STRING Specifies the message describing the event + + +
timestamp STRING Specifies the time when the event occurred (UTC) + + +
type STRING Specifies the event classification [INFO, WARNING, ERROR] + + +
wlan0 OBJECT Current statistics on Wi-Fi as WAN interface + + -
channels ARRAY Reports a list of available channels + + -
countryCode STRING Specifies the two-character operating country code + + -
ip STRING Specifies the IP address assigned to this interface + + -
link OBJECT Reports status of the current Wi-Fi connection + - -
RX STRING Reports the number of received bytes + - -
SSID STRING Reports the SSID of connected network + - -
TX STRING Reports status of the current Wi-Fi connection + - -
freq STRING Reports the operating frequency + - -
Convergence API Version 2.2 P a g e | 66
Element Type Description Conv AEP MTR
mac STRING Reports network MAC address of the Access Point + - -
signal STRING Specifies the received signal strength indication in dBm + - -
tx_bitrate STRING Reports the speed at which bits are transmitted over the medium + - -
mask STRING Specifies the mask assigned to this interface + - -
mtu STRING Specifies maximum transmission unit in byte + + -
rx OBJECT Contains statistics on received bytes + + -
bytes STRING Specifies the number of received bytes + + -
dropped STRING Specifies the number of received byte drops + + -
errors STRING Specifies the number of received byte errors + + -
frame STRING Specifies the number of received frames + + -
overruns STRING Specifies the number of received overruns + + -
packets STRING Specifies the number of received packets + + -
status STRING Reports the state of the network interface + + -
tx OBJECT Contains statistics on transmitted bytes + + -
bytes STRING Specifies the number of transmitted bytes + + -
carrier STRING Specifies the number of transmitted carriers + + -
collisions STRING Specifies the number of transmitted collisions + + -
dropped STRING Specifies the number of transmitted drops + + -
errors STRING Specifies the number of transmitted errors + + -
overruns STRING Specifies the number of transmitted overruns + + -
packets STRING Specifies the number of transmitted packets + + -
queueLength STRING Specifies the number of packets that can be queued for + + - transmission
link STRING status of the wifi link - + -
wlan0History ARRAY Specifies daily statistics on Wi-Fi as WAN interface traffic + + -
date UINT Specifies the time stamp in seconds + + -
Convergence API Version 2.2 P a g e | 67
Element Type Description Conv AEP MTR
todayRx UINT Specifies the number of received bytes for a day + + -
todayTx UINT Specifies the number of transmitted bytes for a day + + -
wlan0Total OBJECT Total and today’s statistics on the Wi-Fi as WAN interface traffic + + -
todayRx UINT Specifies the number of bytes received during the pre-determined + + - period
todayTx UINT Specifies the number of bytes transmitted during the pre- + + - determined period
totalRx UINT Specifies the number of bytes received today + + -
totalTx UINT Specifies the number of bytes transmitted today + + -
wlan1 OBJECT Current statistics on Wi-Fi AP interface + + -
channels ARRAY Reports a list of available channels + + -
countryCode STRING Specifies the two-character operating country code + + -
ip STRING Specifies the IP address assigned to this interface + + -
mask STRING Specifies the mask assigned to this interface + - -
mtu STRING Specifies maximum transmission unit in bytes + + -
rx OBJECT Contains statistics on received bytes + + -
bytes STRING Specifies the number of received bytes + + -
dropped STRING Specifies the number of received byte drops + + -
errors STRING Specifies the number of received byte errors + + -
frame STRING Specifies the number of received frames + + -
overruns STRING Specifies the number of received overruns + + -
packets STRING Specifies the number of received packets + + -
tx OBJECT Contains statistics on transmitted bytes + + -
bytes STRING Specifies the number of transmitted bytes + + -
carrier STRING Specifies the number of transmitted carriers + + -
collisions STRING Specifies the number of transmitted collisions + + -
dropped STRING Specifies the number of transmitted drops + + -
Convergence API Version 2.2 P a g e | 68
Element Type Description Conv AEP MTR
errors STRING Specifies the number of transmitted errors + + -
overruns STRING Specifies the number of transmitted overruns + + -
packets STRING Specifies the number of transmitted packets + + -
queueLength STRING Specifies the number of packets that can be queued for + + - transmission
link STRING status of the wifi link - + -
wlan1History ARRAY Specifies daily statistics on Wi-Fi AP interface traffic + + -
date UINT Specifies the time stamp in seconds + + -
todayRx UINT Specifies the number of received bytes for a day + + -
todayTx UINT Specifies the number of transmitted bytes for a day + + -
wlan1Total OBJECT Total and today statistics on the Wi-Fi as WAN interface traffic + + -
todayRx UINT Specifies the number of bytes received today + + -
todayTx UINT Specifies the number of bytes transmitted today + + -
totalRx UINT Specifies the number of bytes received during the pre-determined + + - period
totalTx UINT Specifies the number of bytes transmitted during the pre- + + - determined period
ethHistory ARRAY daily statistics on ethernet interface traffic - - +
date UINT time stamp (in seconds) - - +
todayRx UINT number of received bytes for a day - - +
todayTx UINT number of transmitted bytes for a day - - +
ethTotal OBJECT total and today statistics on the ethernet interface traffic - - +
todayRx UINT number of received bytes for today - - +
todayTx UINT number of transmitted bytes for today - - +
totalRx UINT number of received bytes for the stored period - - +
totalTx UINT number of transmitted bytes for the stored period - - +
lan OBJECT statistics on local area network - - +
Convergence API Version 2.2 P a g e | 69
Element Type Description Conv AEP MTR
ip STRING the ip address assigned to this interface - - +
mtu STRING maximum transmission unit in bytes - - +
rx OBJECT statistics on local area network received bytes - - +
bytes STRING number of received bytes - - +
dropped STRING number of received byte drops - - +
errors STRING number of received byte errors - - +
frame STRING number of received frames - - +
overruns STRING number of received overruns - - +
packets STRING number of received packets - - +
tx OBJECT statistics on local area network transmitted bytes - - +
bytes STRING number of transmitted bytes - - +
carrier STRING number of transmitted carriers - - +
collisions STRING number of transmitted collisions - - +
dropped STRING number of transmitted drops - - +
errors STRING number of transmitted errors - - +
overruns STRING number of transmitted overruns - - +
packets STRING number of transmitted packets - - +
queueLength STRING number of packets that can be queued for transmission - - +
wlan OBJECT statistics on wlan interface - - +
channels ARRAY array of available channels - - +
countryCode STRING code used to assign Wi-Fi hardware to use country's authorized - - + frequencies
ip STRING the ip address assigned to this interface - - +
link STRING status of the Wi-Fi link - - +
mtu STRING maximum transmission unit in bytes - - +
rx OBJECT statistics on Wi-Fi interface received bytes - - +
Convergence API Version 2.2 P a g e | 70
Element Type Description Conv AEP MTR
bytes STRING number of received bytes - - +
dropped STRING number of received byte drops - - +
errors STRING number of received byte errors - - +
frame STRING number of received frames - - +
overruns STRING number of received overruns - - +
packets STRING number of received packets - - +
tx OBJECT statistics on Wi-Fi interface transmitted bytes - - +
bytes STRING number of transmitted bytes - - +
carrier STRING number of transmitted carriers - - +
collisions STRING number of transmitted collisions - - +
dropped STRING number of transmitted drops - - +
errors STRING number of transmitted errors - - +
overruns STRING number of transmitted overruns - - +
packets STRING number of transmitted packets - - +
queueLength STRING number of packets that can be queued for transmission - - +
wlanHistory ARRAY daily statistics on wlan interface traffic - - +
date UINT time stamp (in seconds) - - +
todayRx UINT number of received bytes for a day - - +
todayTx UINT number of transmitted bytes for a day - - +
wlanTotal OBJECT total and today statistics on the wlan interface traffic - - +
todayRx UINT number of received bytes for today - - +
todayTx UINT number of transmitted bytes for today - - +
totalRx UINT number of received bytes for the stored period - - +
totalTx UINT number of transmitted bytes for the stored period - - + syslog Description: Defines the syslog support settings : OBJECT
Convergence API Version 2.2 P a g e | 71
Element Type Description Conv AEP MTR
cellDataHistory UINT Specifies the number of days cellular history is kept in the device + + +
enabled BOOL Enables or disables remote logging (default:false) + + +
ethDataHistory UINT Specifies the number of days to keep Ethernet history in the + + + device
ipAddress STRING Specifies the remote syslog server’s IP address + + +
logLevel UINT Specifies the level of debug output to log: 20(warning), 30(info), + + + 50(debug), 60(trace), or 100(maximum) (default:30)
outputToFile BOOL Enables or disables syslog output to file (default:false) + + +
saveDataLimit UINT Specifies the data limit to update the statistics in MB + + +
saveTimeout UINT Specifies the amount of time the device has to update the + + + statistics in seconds
wifiDataHistory UINT Specifies the number of days Wi-Fi history is kept in the device + + + system Description: Defines the system attributes : OBJECT
Element Type Description Conv AEP MTR
accessoryCards ARRAY Specifies the list of installed accessory cards + + -
capabilities OBJECT Reports hardware capabilities + + +
adc BOOL Specifies whether the device supports analog inputs + + +
bluetooth BOOL Specifies whether the device supports Bluetooth + + +
cell BOOL Specifies whether the device supports Cellular + + +
cellWwan BOOL Specifies whether the cellular radio supports QMI WWAN + - + interface
din BOOL Specifies whether the device supports digital inputs + + +
dout BOOL Specifies whether the device supports digital outputs + + +
externalSerialPort BOOL Specifies whether the device supports an external serial port + - +
flexibleSerialPort BOOL Specifies whether the device supports a flexible serial port + - +
gpio BOOL Specifies whether the device supports GPIO + + -
gps BOOL Specifies whether the device supports GPS + + +
Convergence API Version 2.2 P a g e | 72
Element Type Description Conv AEP MTR
lora BOOL Specifies whether the device supports LoRa + + -
loraNetworkServer BOOL Specifies whether the LoRa Network Server is installed + + -
nodeRed BOOL Specifies whether the if Node-RED server is installed false + + -
rs232 BOOL Specifies whether the device supports RS-232 interface + + +
rs422 BOOL Specifies whether the device supports RS-422 interface + + +
rs485 BOOL Specifies whether the device supports RS-485 interface + + +
serial BOOL Specifies whether the device supports external serial port + + +
wifi BOOL Specifies whether the device supports Wi-Fi + + +
cmdtty STRING Specifies the TTY device that issues AT commands to the device + + +
date STRING Specifies the current system date + + +
datetime STRING Specifies the current system date and time + + +
dbDirty BOOL Specifies whether the database is in a dirty state + + +
defaultDeviceName STRING Specifies the default name of the device + + +
deviceId STRING Specifies the device ID + + +
deviceName STRING Specifies the configured name of the device + + +
firmware STRING Specifies the firmware version + + +
firmwareDate STRING Specifies the date the firmware was built + + +
firstTimeSetup BOOL Specifies whether the device is set to default values + + +
hardwareVersion STRING Specifies the hardware version of the device + + +
imei STRING Specifies the international mobile station equipment identity + + +
imsi STRING Specifies the international mobile subscriber identity + + +
loraEui STRING EUI of the build-in LoRa card + + -
loraFpgaVersion UINT FPGA firmware version of the build-in LoRa card + + -
loraHwVersion STRING Hardware Version of the build-in LoRa card + + -
loraProductId STRING Product ID of the build-in LoRa card + + -
macAddress STRING Specifies the MAC address of the device’s Ethernet port + + +
Convergence API Version 2.2 P a g e | 73
Element Type Description Conv AEP MTR
macBluetooth STRING Specifies the MAC address of the device’s Bluetooth module + + +
macWifi STRING Specifies the MAC address of the device’s Wi-Fi module + + +
memory OBJECT Contains a list of the current memory statistics + + +
mode STRING Specifies the system level mode of the device (default:ROUTER) + + +
oemId STRING Specifies configurable device id + + +
permission STRING Specifies the authorization level of the active user + + +
platform STRING NOTE: this is not a part of public API (do not share) + - -
ppptty STRING Specifies the TTY device that PPP uses to make connections + + +
productId STRING Specifies the product ID + + +
radio OBJECT Specifies the radio’s model number and type + + +
carrier STRING Specifies the carrier currently providing cellular connectivity + + +
code STRING Specifies the radio model’s code number: H5, H6, EV3, C2, G3, + + + LAT1, VW2 or LEU1
firmware STRING Specifies radio firmware version + - -
type STRING Specifies the type of radio, GSM, CMDA or LTE + + +
restartNeeded BOOL Specifies whether settings have been changed and a restart is + + + require to reflect those changes in services
signedFirmwareValidation BOOL Enable to require a signed firmware and perform a signature + - + validation before the firmware upgrade. (default:true)
time STRING Specifies the current system time of the device + + +
uptime STRING Specifies how long the device has been running + + +
user STRING Specifies the user currently logged in + + +
uuid STRING uuid + + -
vendorId STRING Specifies the vendor of the device + + +
webTitle STRING Specifies the title configured to display in a browser + + + telnet Description: : NOTE: this is not a part of public API anymore (do not share)
Convergence API Version 2.2 P a g e | 74
telnetServer Description: : NOTE: this is not a part of public API anymore (do not share) trustedIp Description: Filter incoming packets depending on the white or black IP addresses list : OBJECT
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables the Trusted IP functionality (default:false) + - +
mode STRING Specifies the configuration mode, black list or white list. In the + - + white list mode the incoming traffic from the trusted IP addresses will be processed, other traffic will be dropped. In the black list mode the incoming traffic from the Trusted IP addresses will be dropped, other traffic will be processed. valid values are 'whitelist', 'blacklist'. (default:'whitelist')
rules ARRAY A list of trusted IP filtering rules + - +
dstPort STRING Specifies the destination port. examples [5000], [6000:6002], + - + [5000,6000-6002,8000:8010] (default:ANY)
ipMode STRING Specifies the source IP address mode. Use a single IP address with + - + subnet mask (subnet mode) or IP range (range mode). valid values are 'subnet', 'range'
name STRING Specifies the rule name + - +
protocol STRING Specifies the Internet protocol to use. valid values are 'TCP', 'UDP', + - + 'TCP/UDP' and 'ANY' (default:ANY)
rangeSrcAddrEnd STRING Specifies the source IP address end. The address is used only if + - + ipMode is 'range'. example: [10.10.10.20]
rangeSrcAddrStart STRING Specifies the source IP address start. The address is used only if + - + ipMode is 'range'. example: [10.10.10.10]
subnetSrcAddr STRING Specifies the source IP address. The address is used only if ipMode + - + is 'subnet'. example: [10.10.10.10]
subnetSrcMask STRING Specifies the source IP mask. The address is used only ifipMode is + - + 'subnet'. examples [255.255.255.0], [24] users Description: Stores a list of users for authentication purposes : ARRAY
Element Type Description Conv AEP MTR
__v UINT Version of model [2] (automatic) + - -
address STRING Specifies user’s contact address + - -
Convergence API Version 2.2 P a g e | 75
Element Type Description Conv AEP MTR
city STRING Specifies user’s city + - -
country STRING Specifies user’s country + - -
creationDate STRING Indicates account creation date + - -
division STRING Specifies user’s organizational unit + - -
email STRING Specifies user’s contact email + - -
employeeId STRING Specifies user’s organizational ID + - -
enabled BOOL Enables or disables user’s account + - -
firstName STRING Specifies user’s first name + - -
lastLoginDate STRING Indicates last login date + - -
lastName STRING Specifies last name + - -
mobilePhone STRING Specifies user’s mobile phone + - -
name STRING Specifies user’s login + + +
passwordChangedDate STRING Indicates password change date + - -
permission STRING Indicates permissions level: admin, user or guest + + +
postalCode STRING Specifies user’s ZIP code + - -
state STRING Specifies user’s state + - -
title STRING Specifies user’s title + - -
workPhone STRING Specifies user’s work phone + - -
password STRING password hash - + + waninfo Description: Stores information on WAN interfaces : OBJECT
Element Type Description Conv AEP MTR
wans ARRAY Contains a list of WANs + + +
available BOOL Indicates whether the WAN interface is available + + +
current BOOL Specifies whether the interface is the current WAN transport + + -
enabled BOOL Indicates whether the WAN is enabled + + +
Convergence API Version 2.2 P a g e | 76
Element Type Description Conv AEP MTR
gateway STRING Specifies the gateway used by the WAN + + +
interface STRING Specifies the network interface used by the WAN + + +
ip STRING Specifies the IP address assigned to this interface + + +
name STRING Specifies the name of the WAN + + +
subnet STRING Specifies the subnet of the network + + +
type STRING Specifies the type of WAN + + + wanmngr Description: Defines the WAN management settings : OBJECT
Element Type Description Conv AEP MTR
mode STRING Specifies the WAN’s manager mode (default:'FAILOVER') + + +
wans ARRAY Specifies a WAN’s settings + + +
interface STRING Specifies the WAN’s network interface + + +
monitor OBJECT Specifies the WAN’s failover settings + + +
active OBJECT Specifies the active detection mode settings + + +
hostname STRING Specifies the host to connect to (default:'www.google.com') + + +
icmpCount UINT Specifies the number of pings to send (1-200, default:10) + + +
tcpPort UINT Specifies which port to connect to on the host (default:80) + + +
type STRING Specifies the method to use for availability detection, ICMP or TCP + + + (default:'ICMP')
checkInterval UINT Specifies the failover check interval in seconds (default:60) + + +
mode STRING Specifies the failover availability detection mode + + + (default:'ACTIVE')
priority UINT Specifies the priority for the WAN + + +
weight UINT Specifies the weight, the value is used for load balancing mode + + + only wifi Description: Defines the Wi-Fi services settings : OBJECT
Convergence API Version 2.2 P a g e | 77
Element Type Description Conv AEP MTR
ap OBJECT Specifies the Wi-Fi access point settings + + +
beaconInterval UINT Specifies the time between beacon frames in milliseconds + + + (default:100)
channel STRING Specifies the preferred wireless channel (default:AUTO) + + +
countryCode STRING Specifies the two-character operating country code + + +
dtimInterval UINT Specifies the number of frames between delivery traffic indication + + + messages for buffered multicast/broadcast data (default:1)
enabled BOOL Enables or disables the Wi-Fi access point (default:false) + + +
maxClients UINT Specifies the maximum number of clients allowed on the access + + + point at any given time (default: 5)
networkMode STRING Specifies the radio mode of operation for the access point, [b, n, + + + bg, or bgn] (default:bgn)
region STRING Specifies the region to control configuration of 5 GHz channels + + -
rtsThreshold UINT Specifies the RTS (Request To Send) threshold (default:2347) + + +
security OBJECT Contains the Wi-Fi access point security settings + + +
algorithm STRING Specifies the algorithm used with WPA modes, TKIP, AES, or + + + TKIP+AES (default:TKIP+AES)
mode STRING Specifies the security mode used on the access point: NONE, WEP, + + + WPA-PSK or WPA2-PSK (default:NONE)
psk STRING Specifies the pre-shared key for client authentication + + +
ssid STRING Specifies the network SSID, which may contain only alpha- + + + numeric characters and symbols not including ?, ", $, [, n, ] and + characters
chipType STRING Specifies the type of Wi-Fi chip + - -
NOTE: this is not a part of public API (do not share)
client OBJECT Specifies the Wi-Fi client settings + + +
enabled BOOL Enables or disables the Wi-Fi client (default:false) + + +
mode STRING Specifies the mode used for the Wi-Fi interface, currently the only + + + mode available is WAN
savedNetworks ARRAY Contains a list of networks the Wi-Fi client uses to find a + + + connection
Convergence API Version 2.2 P a g e | 78
Element Type Description Conv AEP MTR
enabled BOOL Enables or disables the use of a saved network when trying to + + + connect
name STRING Specifies the name of the saved network + + +
security OBJECT Specifies the Wi-Fi client security settings + + +
algorithm STRING Specifies the algorithm used with WPA modes: TKIP, AES, or + + + TKIP+AES (default:TKIP+AES)
mode STRING Specifies the security mode (default:NONE) + + +
password STRING Specifies the password used to connect to the network + + +
psk STRING Specifies the pre-shared key used to connect to the network + + +
username STRING Specifies the username used to connect to the network + + +
ssid STRING Specifies the network SSID + + +
wpaConfig OBJECT Specifies the settings gathered from a Wi-Fi scan + + +
dual_band BOOL Reports capability to transmit on the 5 GHz and 2.4 GHz wireless + + - bands
networks ARRAY Contains a list of networks found during the most recent Wi-Fi + + + scan networks Description: array of networks to be used in setting filters and tunnels : ARRAY
NOTE: this collection is not to be used anymore (do not share)
Element Type Description Conv AEP MTR
ip STRING ip address of network - + +
mask UINT network mask (0-32) - + +
name STRING name of network - + +
type STRING type of network, STATIC or DYNAMIC, configured networks should - + + be set as DYNAMIC status Description: : NOTE: this is not a part of public API (do not share)
Convergence API Version 2.2 P a g e | 79
Change History Version Description Author Date (YYYY/MM/DD)
1.0 New document Sergii Shchelkanov 2019/03/20
2.0 Updated descriptions for the elements Sergii Shchelkanov 2019/04/17
2.1 Reviewed Mykyta Dorokhin 2019/04/18
2.2 Reviewed Anastasiia Logvinova 2019/04/20
Convergence API Version 2.2 P a g e | 80