{"id":13290,"date":"2016-06-22T10:38:07","date_gmt":"2016-06-22T15:38:07","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=13290"},"modified":"2020-11-04T09:47:15","modified_gmt":"2020-11-04T15:47:15","slug":"remotemgmt","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/remotemgmt\/","title":{"rendered":"remoteManagement"},"content":{"rendered":"<p>Description: Remote Management settings : OBJECT<\/p>\n<table style=\"width: 600px; border-collapse: collapse;\" border=\"1\" cellspacing=\"0\" cellpadding=\"0\">\n<tbody>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; background: #4F81BD; padding: 0in .01in 0in .01in; color: white;\" valign=\"top\" width=\"150\"><strong>Element<\/strong><\/td>\n<td style=\"border: solid #4F81BD 1.0pt; background: #4F81BD; padding: 0in .01in 0in .01in; color: white;\" valign=\"top\" width=\"75\"><strong>Type<\/strong><\/td>\n<td style=\"border: solid #4F81BD 1.0pt; background: #4F81BD; padding: 0in .01in 0in .01in; color: white;\" valign=\"top\" width=\"350\"><strong>Description<\/strong><\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">accountKey<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Account key registered to the user by the device management platform<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">allowConfigurationUpgrade<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Allows configuration upgrades to be managed through device management platform (default:true)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">allowConfigurationUpload<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Allows the device configuration to be uploaded to remote management platform (default:true)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">allowFirmwareUpgrade<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Allows firmware upgrades to be managed through device management platform (default:true)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">allowRadioFirmwareUpgrade<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Allows radio firmware upgrades to be managed through device management platform (default:true)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">checkInDateTime<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">OBJECT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Configure the device to check in to DeviceHQ at a certain date and time<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0customDays<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Days of the week to check-in to DeviceHQ when the repeatable mode is CUSTOM<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0customTime<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Check-in time in format HH:MM:SS when the repeatable mode is CUSTOM<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0 dailyTime<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Check-in time in format HH:MM:SS when the repeatable mode is DAILY<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0repeatable<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enable or disable check-in to DeviceHQ on a daily basis (default : false)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0repeatableMode<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specify days of the week when to check-in to DeviceHQ. Select DAILY to check-in every day, select CUSTOM to specify particular days of the week<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0single<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enable to perform a single check-in to DeviceHQ at specified date and time (default : false)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0singleDate<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specify exact date to perform a single check-in to DeviceHQ in format MM\/DD\/YYYY<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">\u00a0\u00a0singleTime<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specify exact time to perform a single check-in to DeviceHQ in format HH:MM:SS<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">enabled<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enables the device to be managed by a remote management platform (default:false)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">gpsDataInterval<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">UINT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the GPS push interval in seconds (default:43200)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">intervalsEnabled<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enables or disables check-in to DeviceHQ periodically at a specified interval (default:true)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">machineApiAuthToken<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Device API Authentication Token from your Device HQ account for sending backup battery data to Device HQ to display (MTCAP only)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">machineApiSecret<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Device API Secret from your Device HQ account for sending backup battery data to Device HQ to display (MTCAP only)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">queryServerInterval<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">UINT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Specifies the check-in interval in seconds (default:43200)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">serverName<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">STRING<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">URL or IP address of the remote management platform (default:ds.multitech.com)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">serverPort<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">UINT<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Port of the remote management platform (default:5798)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">sslEnabled<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Enables or disables traffic encryption (default:true)<\/td>\n<\/tr>\n<tr>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"150\">syncWithDialOnDemand<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"75\">BOOL<\/td>\n<td style=\"border: solid #4F81BD 1.0pt; padding: 0in .01in 0in .01in;\" valign=\"top\" width=\"350\">Allows the device to contact the remote management platform only when the cellular link is already up (default:false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"<p>Description: Remote Management settings : OBJECT Element Type Description accountKey STRING Account key registered to the user by the device management platform allowConfigurationUpgrade BOOL Allows configuration upgrades to be managed through device management platform (default:true) allowConfigurationUpload BOOL Allows the device configuration to be uploaded to remote management platform (default:true) allowFirmwareUpgrade BOOL Allows firmware upgrades to [&hellip;]<\/p>\n","protected":false},"author":1872,"featured_media":0,"parent":13129,"menu_order":49,"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-13290","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13290","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=13290"}],"version-history":[{"count":9,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13290\/revisions"}],"predecessor-version":[{"id":18372,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13290\/revisions\/18372"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=13290"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}