{"id":13129,"date":"2016-06-22T08:39:22","date_gmt":"2016-06-22T13:39:22","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=13129"},"modified":"2023-06-30T11:18:24","modified_gmt":"2023-06-30T16:18:24","slug":"collection-endpoints","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/","title":{"rendered":"Collection Endpoints"},"content":{"rendered":"

Collections are groups of related elements used to configure a service or capability. You can perform four main actions on a collection: get, edit, add, and delete. These actions align with RESTful calls: GET, PUT, POST, and DELETE.<\/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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Collection<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
alert<\/a><\/td>\nOBJECT<\/td>\nContains a list of alerts<\/td>\n<\/tr>\n
appStore<\/a><\/td>\nOBJECT<\/td>\nDefines settings for Application Store (not available on MTR)<\/td>\n<\/tr>\n
apps<\/a><\/td>\nARRAY<\/td>\nContains information on installed Node-RED applications (not available on MTR)<\/td>\n<\/tr>\n
autoDialout<\/a><\/td>\nOBJECT<\/td>\nAllows the use of the cellular modem directly from the serial port<\/td>\n<\/tr>\n
autoReboot<\/a><\/td>\nOBJECT<\/td>\nCauses the device to reboot automatically<\/td>\n<\/tr>\n
battery<\/a><\/td>\nOBJECT<\/td>\nContains the backup battery configuration parameters (MTCAP devices only)<\/td>\n<\/tr>\n
backOffTimers<\/a><\/td>\nOBJECT<\/td>\nStores carrier-defined backoff timers for PPP connections, SMS retries, and modem resets<\/td>\n<\/tr>\n
bluetooth<\/a><\/td>\nOBJECT<\/td>\nAllows a device to connect via Bluetooth<\/td>\n<\/tr>\n
bluetoothLowEnergy<\/a><\/td>\nOBJECT<\/td>\nAllows connecting devices via BLE (depends on model)<\/td>\n<\/tr>\n
bootloader<\/a><\/td>\nOBJECT<\/td>\nBootloader configuration parameters<\/td>\n<\/tr>\n
brand<\/a><\/td>\nOBJECT<\/td>\nCustomizes icons, images, and support information for a rebranded device<\/td>\n<\/tr>\n
btDevices<\/a><\/td>\nARRAY<\/td>\nList of available Bluetooth devices<\/td>\n<\/tr>\n
cacertificates<\/a><\/td>\nOBJECT<\/td>\nManagement of CA (Certifying Authority) certificates<\/td>\n<\/tr>\n
callHome<\/a><\/td>\nOBJECT<\/td>\nEnables the device to call home for configuration files, firmware updates and adds your DeviceHQ account key to the device so it is associated with your
\nDeviceHQ account<\/td>\n<\/tr>\n
cellTimeSync<\/a><\/td>\nOBJECT<\/td>\nDefines the clock synchronization settings using a cellular radio <\/td>\n<\/tr>\n
certificate<\/a><\/td>\nOBJECT<\/td>\nContains secure public key certificate configurations<\/td>\n<\/tr>\n
command<\/a><\/td>\nOBJECT<\/td>\nThe 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.<\/td>\n<\/tr>\n
customApps<\/a><\/td>\nOBJECT<\/td>\nManages installed custom applications (not available on MTR)<\/td>\n<\/tr>\n
customRoles<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
customAppsConfig<\/a><\/td>\nBOOL<\/td>\nSpecifies support for and enables or disables custom applications for MTR devices only<\/td>\n<\/tr>\n
ddns<\/a><\/td>\nOBJECT<\/td>\nUpdates the dynamic domain name server when the IP address changes<\/td>\n<\/tr>\n
dhcp<\/a><\/td>\nOBJECT<\/td>\nStores the DHCP settings<\/td>\n<\/tr>\n
docker<\/a><\/td>\nOBJECT<\/td>\nDocker service configuration (for Conduit 300 only)<\/td>\n<\/tr>\n
dns<\/a><\/td>\nOBJECT<\/td>\nForwards network traffic using DNS<\/td>\n<\/tr>\n
filters<\/a><\/td>\nARRAY<\/td>\nAn array of firewall filters<\/td>\n<\/tr>\n
firewall<\/a><\/td>\nOBJECT<\/td>\nStores some firewall settings<\/td>\n<\/tr>\n
gps<\/a><\/td>\nOBJECT<\/td>\nStores the GPS service settings<\/td>\n<\/tr>\n
greTunnels<\/a><\/td>\nARRAY<\/td>\nStores a list of GRE tunnels<\/td>\n<\/tr>\n
ipPipes<\/a><\/td>\nARRAY<\/td>\nStores a list of configured IP pipes<\/td>\n<\/tr>\n
ipsecTunnels<\/a><\/td>\nARRAY<\/td>\nStores a list of IPsec tunnels<\/td>\n<\/tr>\n
lan<\/a><\/td>\nOBJECT<\/td>\nDefines the LAN interface settings<\/td>\n<\/tr>\n
lldp<\/a><\/td>\nOBJECT<\/td>\nDefines the Link Layer Discovery Protocol configuration settings <\/td>\n<\/tr>\n
log<\/a><\/td>\nARRAY<\/td>\nStores log information<\/td>\n<\/tr>\n
lora<\/a><\/td>\n<\/td>\nLoRa API options are only available when LoRa Network Server is running (not available on MTR)<\/td>\n<\/tr>\n
loraNetwork<\/a><\/td>\nOBJECT<\/td>\nLoRa network interface settings\u00a0(not available on MTR)<\/td>\n<\/tr>\n
nat<\/a><\/td>\nARRAY<\/td>\nStores a list of NAT rules for advanced firewall settings<\/td>\n<\/tr>\n
ni<\/a><\/td>\nOBJECT<\/td>\nSettings for network interfaces<\/td>\n<\/tr>\n
mqttBroker<\/a><\/td>\nOBJECT<\/td>\nSettings for MQTT broker<\/td>\n<\/tr>\n
nodeRed<\/a><\/td>\nOBJECT<\/td>\nNode-RED configuration (not available on MTR)<\/td>\n<\/tr>\n
ovpnTunnels<\/a><\/td>\nARRAY<\/td>\nList of OpenVPN tunnels<\/td>\n<\/tr>\n
packages<\/a><\/td>\nOBJECT<\/td>\nPerform package management operations<\/td>\n<\/tr>\n
passwordComplexityRules<\/a><\/td>\nOBJECT<\/td>\nStores settings for Password Complexity Rules<\/td>\n<\/tr>\n
policy<\/a><\/td>\nOBJECT<\/td>\nUsage policy details<\/td>\n<\/tr>\n
ppp<\/a><\/td>\nOBJECT<\/td>\nDefines the PPP settings<\/td>\n<\/tr>\n
radius<\/a><\/td>\nOBJECT<\/td>\nConfigures Radius settings<\/td>\n<\/tr>\n
remoteAccess<\/a><\/td>\nOBJECT<\/td>\nDefines settings for remote access of the device<\/td>\n<\/tr>\n
remoteManagement<\/a><\/td>\nOBJECT<\/td>\nDefines the remote management settings<\/td>\n<\/tr>\n
resetButton<\/a><\/td>\nOBJECT<\/td>\nDefines reset button behavior configuration<\/td>\n<\/tr>\n
routes<\/a><\/td>\nARRAY<\/td>\nStores a list of static routes<\/td>\n<\/tr>\n
routes<\/a><\/td>\nARRAY<\/td>\nStores a list of static routes<\/td>\n<\/tr>\n
saveAndRestore<\/a><\/td>\nOBJECT<\/td>\nSave and Restore configuration options <\/td>\n<\/tr>\n
scada (BACnet)<\/a><\/td>\nOBJECT<\/td>\nSupervisory control and data acquisition settings <\/td>\n<\/tr>\n
secureProtocols<\/a><\/td>\nARRAY<\/td>\nCipher suites and advanced security options<\/td>\n<\/tr>\n
selfDiagnostic<\/a><\/td>\nOBJECT<\/td>\nSelf-diagnostic settings<\/td>\n<\/tr>\n
serial<\/a><\/td>\nOBJECT<\/td>\nDefines the serial port settings<\/td>\n<\/tr>\n
serialModemPassthrough<\/a><\/td>\nOBJECT<\/td>\nDefine serial modem mode settings<\/td>\n<\/tr>\n
sms<\/a><\/td>\nOBJECT<\/td>\nDefines the SMS settings<\/td>\n<\/tr>\n
smtp<\/a><\/td>\nOBJECT<\/td>\nDefines the SMTP settings<\/td>\n<\/tr>\n
snmp<\/a><\/td>\nOBJECT<\/td>\nDefines the SNMP settings<\/td>\n<\/tr>\n
sntp<\/a><\/td>\nOBJECT<\/td>\nDefines the clock synchronization settings between computer systems<\/td>\n<\/tr>\n
stats<\/a><\/td>\nOBJECT<\/td>\nStatistics for key device features (as shown in UI)<\/td>\n<\/tr>\n
syslog<\/a><\/td>\nOBJECT<\/td>\nDefines the syslog support settings<\/td>\n<\/tr>\n
system<\/a><\/td>\nOBJECT<\/td>\nDefines the system attributes<\/td>\n<\/tr>\n
trustedIp<\/a><\/td>\nOBJECT<\/td>\nFilter incoming packets depending on the white or black IP addresses list<\/td>\n<\/tr>\n
users<\/a><\/td>\nARRAY<\/td>\nStores a list of users for authentication purposes<\/td>\n<\/tr>\n
waninfo<\/a><\/td>\nOBJECT<\/td>\nStores information on WAN interfaces<\/td>\n<\/tr>\n
wanmngr<\/a><\/td>\nOBJECT<\/td>\nDefines the WAN management settings<\/td>\n<\/tr>\n
wifi<\/a><\/td>\nOBJECT<\/td>\nDefines the Wi-Fi services settings<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

Collections are groups of related elements used to configure a service or capability. You can perform four main actions on a collection: get, edit, add, and delete. These actions align with RESTful calls: GET, PUT, POST, and DELETE. Collection Type Description alert OBJECT Contains a list of alerts appStore OBJECT Defines settings for Application Store […]<\/p>\n","protected":false},"author":1872,"featured_media":0,"parent":12977,"menu_order":2,"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-13129","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129","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=13129"}],"version-history":[{"count":93,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129\/revisions"}],"predecessor-version":[{"id":33467,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129\/revisions\/33467"}],"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=13129"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}