Commands

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.

For changes in the last release, refer to the API Change Log

Command  Description Parameters
bootloader_console Controls bootloader silent mode
bootloader_lock Controls password authentication to access the device bootloader
call_home_disable Disables call home feature with DeviceHQ
call_home_enable Enables call home feature with DeviceHQ
checkin_to_devicehq Triggers a check-in to DeviceHQ
clean_oem Clears user-defined default configurations from memory and returns the device to
factory default
continuous_ping_start Starts continuous ping
continuous_ping_stop Stops continuous ping and shows the ping results
curl_password
database_version_check Uploads config file to device and compares the version number
ddns_update Pushes DDNS information to the configured DDNS server
download_config Downloads the current configuration
firmware_check Uploads radio firmware file to device and checks it (POST radio firmware upgrade bin file)  Radio firmware upgrade file
firmware_pre_upgrade Prepares system for radio firmware upgrade (i.e. shuts down Node-RED, Lora Network Server, frees space for the upgrade package)
firmware_upgrade Initiates radio firmware upgrade Radio firmware upgrade file
legacy_sync Synchronizes legacy configurations
loglvl_debug Sets the API’s logging level to DEBUG
loglvl_info Sets the API’s logging level to INFO
loglvl_trace Sets the API’s logging level to TRACE
loglvl_warning Sets the API’s logging level to WARNING
node_red_status Operational status of the Node-RED server
passwd Changes or resets admin account login information including username, ID, and password JSON data including aasID (30 character alphanumeric ID), aasMsg (password), and username (see example to change password)
ping Send a set of ICMP pings to an address or URL, interface can be ANY, LAN, WIFI, CELLULAR, or ETHERNET JSON data
ppp_start Start PPPD
ppp_stop Stop PPPD
ppp_toggle Toggle PPPD
radio The API supports a set of special actions using the Command Radio URL ( api/command/radio ). Execute a command using a POST request call method. A RESTful Get request returns an array of all available commands. OBJECT
radio_activate Attempts to activate the on-board cellular radio (CDMA only) JSON data
radio_cmd Sends a string directly to the cellular radio, timeout must be in milliseconds JSON data
remove_icon Deletes user-supplied icon
remove_image Deletes user-supplied image
remove_logo Deletes user-supplied logo
reset_bluetooth Resets the Bluetooth hardware
reset_modem Resets the cellular radio hardware
reset_wifi Resets the WiFi hardware
restart Restarts device
restart_node_red Restarts Node-RED server  Not available in MTR
restore_defaults Resets the device to the user-defined default if set, to factory default if not
restore_factory Resets the device to factory default
revert Reverts all changes since the last save
save Saves the current configuration
save_apply Saves the current configuration and applies the changes immediately, use “allowRestart=true” option to apply the changes that require device reboot
save_oem Saves current configuration as factory/OEM default
save_restart Saves current configuration and restarts the device
setup_radiobridge_console
sms_send Send a text to a specified recipient 
{
   "recipients": [
      "12345678900",
      "00987654321"
   ],
   "message": "Hello world"
}
telit_upgrade Starts Telit radio firmware upgrade Initiates Telit radio firmware upgrade (POST Telit upgrade bin). LEGACY
upload_config Uploads and sets new configuration Configuration file
upload_icon Uploads and sets new icon Icon file
upload_image Uploads and sets new imagetel Image file
upload_logo Uploads and sets new logo Logo file
vzw_reset_class3_apn Reset the current APN value and obtain APN from the Verizon network. APN value for Verizon.