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 .......................................................................................................................................................................