{"id":13134,"date":"2016-06-22T09:20:55","date_gmt":"2016-06-22T14:20:55","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=13134"},"modified":"2023-06-22T16:20:20","modified_gmt":"2023-06-22T21:20:20","slug":"command-table","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/command-table\/","title":{"rendered":"Commands"},"content":{"rendered":"

The API supports a set of special actions using the Command URL ( api\/command<\/code> ). Execute a command using a POST request\u00a0call method.\u00a0A RESTful Get request returns an array of all\u00a0available commands.<\/p>\n

For changes in the last release, refer to the API Change Log<\/a><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Command<\/strong><\/td>\n\u00a0Description<\/strong><\/td>\nParameters<\/strong><\/td>\n<\/tr>\n
bootloader_console<\/td>\nControls bootloader silent mode<\/td>\n<\/td>\n<\/tr>\n
bootloader_lock<\/td>\nControls password authentication to access the device bootloader<\/td>\n<\/td>\n<\/tr>\n
call_home_disable<\/td>\nDisables call home feature with DeviceHQ<\/td>\n<\/td>\n<\/tr>\n
call_home_enable<\/td>\nEnables call home feature with DeviceHQ<\/td>\n<\/td>\n<\/tr>\n
checkin_to_devicehq<\/td>\nTriggers a check-in to DeviceHQ<\/td>\n<\/td>\n<\/tr>\n
clean_oem<\/td>\nClears user-defined default configurations from memory and returns the device to
\nfactory default<\/td>\n		<\/td>\n<\/tr>\n
continuous_ping_start<\/td>\nStarts continuous ping<\/td>\n<\/td>\n<\/tr>\n
continuous_ping_stop<\/td>\nStops continuous ping and shows the ping results<\/td>\n<\/td>\n<\/tr>\n
curl_password<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
database_version_check<\/td>\nUploads config file to device and compares the version number<\/td>\n<\/td>\n<\/tr>\n
ddns_update<\/td>\nPushes DDNS information to the configured DDNS server<\/td>\n<\/td>\n<\/tr>\n
download_config<\/td>\nDownloads the current configuration<\/td>\n<\/td>\n<\/tr>\n
firmware_check<\/td>\nUploads radio firmware file to device and checks it (POST radio firmware upgrade bin file)<\/td>\n\u00a0Radio firmware upgrade file<\/td>\n<\/tr>\n
firmware_pre_upgrade<\/td>\nPrepares system for radio firmware upgrade (i.e. shuts down Node-RED, Lora Network Server, frees space for the upgrade package)<\/td>\n<\/td>\n<\/tr>\n
firmware_upgrade<\/td>\nInitiates radio firmware upgrade<\/td>\nRadio firmware upgrade file<\/td>\n<\/tr>\n
legacy_sync<\/td>\nSynchronizes legacy configurations<\/td>\n<\/td>\n<\/tr>\n
loglvl_debug<\/td>\nSets the API’s logging level to DEBUG<\/td>\n<\/td>\n<\/tr>\n
loglvl_info<\/td>\nSets the API’s logging level to INFO<\/td>\n<\/td>\n<\/tr>\n
loglvl_trace<\/td>\nSets the API’s logging level to TRACE<\/td>\n<\/td>\n<\/tr>\n
loglvl_warning<\/td>\nSets the API’s logging level to WARNING<\/td>\n<\/td>\n<\/tr>\n
node_red_status<\/td>\nOperational status of the Node-RED server<\/td>\n<\/td>\n<\/tr>\n
passwd<\/td>\nChanges or resets admin account login information including username, ID, and password<\/td>\nJSON data including aasID (30 character alphanumeric ID), aasMsg (password), and username (see example<\/a>\u00a0to change password)<\/td>\n<\/tr>\n
ping<\/td>\nSend a set of ICMP pings to an address or URL, interface can be ANY, LAN, WIFI, CELLULAR, or ETHERNET<\/td>\nJSON data<\/td>\n<\/tr>\n
ppp_start<\/td>\nStart PPPD<\/td>\n<\/td>\n<\/tr>\n
ppp_stop<\/td>\nStop PPPD<\/td>\n<\/td>\n<\/tr>\n
ppp_toggle<\/td>\nToggle PPPD<\/td>\n<\/td>\n<\/tr>\n
radio<\/a><\/td>\nThe 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.<\/td>\nOBJECT<\/td>\n<\/tr>\n
radio_activate<\/td>\nAttempts to activate the on-board cellular radio (CDMA only)<\/td>\nJSON data<\/td>\n<\/tr>\n
radio_cmd<\/td>\nSends a string directly to the cellular radio, timeout must be in milliseconds<\/td>\nJSON data<\/td>\n<\/tr>\n
remove_icon<\/td>\nDeletes user-supplied icon<\/td>\n<\/td>\n<\/tr>\n
remove_image<\/td>\nDeletes user-supplied image<\/td>\n<\/td>\n<\/tr>\n
remove_logo<\/td>\nDeletes user-supplied logo<\/td>\n<\/td>\n<\/tr>\n
reset_bluetooth<\/td>\nResets the Bluetooth hardware<\/td>\n<\/td>\n<\/tr>\n
reset_modem<\/td>\nResets the cellular radio hardware<\/td>\n<\/td>\n<\/tr>\n
reset_wifi<\/td>\nResets the WiFi hardware<\/td>\n<\/td>\n<\/tr>\n
restart<\/td>\nRestarts device<\/td>\n<\/td>\n<\/tr>\n
restart_node_red<\/td>\nRestarts Node-RED server<\/td>\n\u00a0Not available in MTR<\/td>\n<\/tr>\n
restore_defaults<\/td>\nResets the device to the user-defined default if set, to factory default if not<\/td>\n<\/td>\n<\/tr>\n
restore_factory<\/td>\nResets the device to factory default<\/td>\n<\/td>\n<\/tr>\n
revert<\/td>\nReverts all changes since the last save<\/td>\n<\/td>\n<\/tr>\n
save<\/td>\nSaves the current configuration<\/td>\n<\/td>\n<\/tr>\n
save_apply<\/td>\nSaves the current configuration and applies the changes immediately, use “allowRestart=true” option to apply the changes that require device reboot<\/td>\n<\/td>\n<\/tr>\n
save_oem<\/td>\nSaves current configuration as factory\/OEM default<\/td>\n<\/td>\n<\/tr>\n
save_restart<\/td>\nSaves current configuration and restarts the device<\/td>\n<\/td>\n<\/tr>\n
setup_radiobridge_console<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
sms_send<\/td>\nSend a text to a specified recipient<\/td>\n\n
{\r\n   \"recipients\": [\r\n      \"12345678900\",\r\n      \"00987654321\"\r\n   ],\r\n   \"message\": \"Hello world\"\r\n}<\/pre>\n<\/td>\n<\/tr>\n
telit_upgrade<\/td>\nStarts Telit radio firmware upgrade<\/td>\nInitiates Telit radio firmware upgrade (POST Telit upgrade bin). LEGACY<\/td>\n<\/tr>\n
upload_config<\/td>\nUploads and sets new configuration<\/td>\nConfiguration file<\/td>\n<\/tr>\n
upload_icon<\/td>\nUploads and sets new icon<\/td>\nIcon file<\/td>\n<\/tr>\n
upload_image<\/td>\nUploads and sets new imagetel<\/td>\nImage file<\/td>\n<\/tr>\n
upload_logo<\/td>\nUploads and sets new logo<\/td>\nLogo file<\/td>\n<\/tr>\n
vzw_reset_class3_apn<\/td>\nReset the current APN value and obtain APN from the Verizon network.<\/td>\nAPN value for Verizon.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

The API supports a set of special actions using the Command URL ( api\/command ). Execute a command using a POST request\u00a0call method.\u00a0A RESTful Get request returns an array of all\u00a0available commands. For changes in the last release, refer to the API Change Log Command \u00a0Description Parameters bootloader_console Controls bootloader silent mode bootloader_lock Controls password […]<\/p>\n","protected":false},"author":1872,"featured_media":0,"parent":12977,"menu_order":4,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-13134","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13134","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1872"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=13134"}],"version-history":[{"count":59,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13134\/revisions"}],"predecessor-version":[{"id":33427,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13134\/revisions\/33427"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/12977"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=13134"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}