Collection Endpoints
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 (not available on MTR) |
| apps | ARRAY | Contains information on installed Node-RED applications (not available on MTR) |
| [p2p slug=”autodialout”] | OBJECT | Allows the use of the cellular modem directly from the serial port |
| [p2p slug=”autoreboot”] | OBJECT | Causes the device to reboot automatically |
| battery | OBJECT | Contains the backup battery configuration parameters (MTCAP devices only) |
| [p2p slug=”backofftimers”] | OBJECT | Stores carrier-defined backoff timers for PPP connections, SMS retries, and modem resets |
| [p2p slug=”bluetooth”] | OBJECT | Allows a device to connect via Bluetooth |
| bluetoothLowEnergy | OBJECT | Allows connecting devices via BLE (depends on model) |
| bootloader | OBJECT | Bootloader configuration parameters |
| [p2p slug=”brand”] | OBJECT | Customizes icons, images, and support information for a rebranded device |
| btDevices | ARRAY | List of available Bluetooth devices |
| cacertificates | OBJECT | Management of CA (Certifying Authority) certificates |
| callHome | OBJECT | Enables 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 DeviceHQ account |
| cellTimeSync | OBJECT | Defines the clock synchronization settings using a cellular radio |
| [p2p slug=”certificate”] | OBJECT | Contains secure public key certificate configurations |
| command | OBJECT | 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. |
| customApps | OBJECT | Manages installed custom applications (not available on MTR) |
| customRoles | ||
| customAppsConfig | BOOL | Specifies support for and enables or disables custom applications for MTR devices only |
| [p2p slug=”ddns”] | OBJECT | Updates the dynamic domain name server when the IP address changes |
| [p2p slug=”dhcp”] | OBJECT | Stores the DHCP settings |
| docker | OBJECT | Docker service configuration (for Conduit 300 only) |
| [p2p slug=”dns”] | OBJECT | Forwards network traffic using DNS |
| [p2p slug=”filters”] | ARRAY | An array of firewall filters |
| firewall | OBJECT | Stores some firewall settings |
| [p2p slug=”gps”] | OBJECT | Stores the GPS service settings |
| [p2p slug=”greTunnels”] | ARRAY | Stores a list of GRE tunnels |
| [p2p slug=”ipPipes”] | ARRAY | Stores a list of configured IP pipes |
| [p2p slug=”ipsecTunnels”] | ARRAY | Stores a list of IPsec tunnels |
| [p2p slug=”lan”] | OBJECT | Defines the LAN interface settings |
| lldp | OBJECT | Defines the Link Layer Discovery Protocol configuration settings |
| log | ARRAY | Stores log information |
| lora | LoRa API options are only available when LoRa Network Server is running (not available on MTR) | |
| loraNetwork | OBJECT | LoRa network interface settings (not available on MTR) |
| [p2p slug=”nat”] | ARRAY | Stores a list of NAT rules for advanced firewall settings |
| ni | OBJECT | Settings for network interfaces |
| mqttBroker | OBJECT | Settings for MQTT broker |
| nodeRed | OBJECT | Node-RED configuration (not available on MTR) |
| ovpnTunnels | ARRAY | List of OpenVPN tunnels |
| packages | OBJECT | Perform package management operations |
| passwordComplexityRules | OBJECT | Stores settings for Password Complexity Rules |
| policy | OBJECT | Usage policy details |
| [p2p slug=”ppp”] | OBJECT | Defines the PPP settings |
| radius | OBJECT | Configures Radius settings |
| [p2p slug=”remoteaccess”] | OBJECT | Defines settings for remote access of the device |
| [p2p slug=”remotemgmt”] | OBJECT | Defines the remote management settings |
| resetButton | OBJECT | Defines reset button behavior configuration |
| [p2p slug=”routes”] | ARRAY | Stores a list of static routes |
| [p2p slug=”routes”] | ARRAY | Stores a list of static routes |
| [p2p slug=”saveAndRestore”] | OBJECT | Save and Restore configuration options |
| scada (BACnet) | OBJECT | Supervisory control and data acquisition settings |
| secureProtocols | ARRAY | Cipher suites and advanced security options |
| selfDiagnostic | OBJECT | Self-diagnostic settings |
| [p2p slug=”serial”] | OBJECT | Defines the serial port settings |
| serialModemPassthrough | OBJECT | Define serial modem mode settings |
| [p2p slug=”sms”] | OBJECT | Defines the SMS settings |
| [p2p slug=”smtp”] | OBJECT | Defines the SMTP settings |
| snmp | OBJECT | Defines the SNMP settings |
| [p2p slug=”sntp”] | OBJECT | Defines the clock synchronization settings between computer systems |
| stats | OBJECT | Statistics for key device features (as shown in UI) |
| [p2p slug=”syslog”] | OBJECT | Defines the syslog support settings |
| [p2p slug=”system”] | OBJECT | Defines the system attributes |
| trustedIp | OBJECT | Filter incoming packets depending on the white or black IP addresses list |
| [p2p slug=”users”] | ARRAY | Stores a list of users for authentication purposes |
| [p2p slug=”waninfo”] | OBJECT | Stores information on WAN interfaces |
| [p2p slug=”wanmngr”] | OBJECT | Defines the WAN management settings |
| [p2p slug=”wifi”] | OBJECT | Defines the Wi-Fi services settings |