Web Services

The Remote Manager modern v1 API is a REST API with consistent naming and common payloads. This API accepts and returns json content.

The Remote Manager legacy web service API covers many objects which are also covered by the v1 modern API. Where possible, use the modern v1 API.

The legacy API is based on XML. For most APIs, you can get json payload by specifying the Accept HTTP header with a value of application/json.

v1 Web service GET POST PUT DELETE Description
v1/ ✅ API List
v1/account ✅ Account properties
v1/alerts ✅ ✅ ✅ ✅ Alert properties
v1/api_keys ✅ ✅ ✅ API keys
v1/automations ✅ ✅ ✅ ✅ Automations and scheduled automations properties
v1/configs ✅ ✅ ✅ ✅ Configuration properties
v1/containers ✅ ✅ ✅ ✅ Containers available for devices
v1/device_logs ✅ ✅ Device logs uploaded from devices
v1/devices ✅ ✅ ✅ ✅ Device and selected properties
v1/events ✅ Event properties
v1/files ✅ ✅ ✅ ✅ File management
v1/firmware ✅ ✅ ✅ ✅ Firmware management
v1/firmware_updates ✅ ✅ ✅ Firmware updates
v1/groups ✅ ✅ ✅ ✅ Group properties
v1/health_configs ✅ ✅ ✅ Device health configurations
v1/jobs ✅ ✅ ✅ ✅ Job properties
v1/metadata ✅ Device descriptors
v1/monitors ✅ Query monitors
v1/notification_configs ✅ ✅ ✅ ✅ Notification Configurations
v1/notifications ✅ ✅ Notifications
v1/reports ✅ ✅ ✅ ✅ Device reports
v1/security_policies ✅ ✅ ✅ ✅ Security policies
v1/settings ✅ Device settings
v1/streams ✅ ✅ ✅ ✅ Data stream and points management
v1/subaccounts ✅ ✅ ✅ Subaccount properties
v1/users ✅ ✅ ✅ ✅ User properties
Web service GET POST PUT DELETE Description
Alarm ✅ ✅ ✅ ✅ Alarm and alarm properties
AlarmStatus ✅ ✅ Alarm status information
AlarmStatusHistory ✅ Alarm status history information
AlarmTemplate ✅ Alarm templates
CarrierAuth ✅ ✅ ✅ ✅ Carrier authorization
CustomerRatePlan ✅ Customer rate plan information
DataPoint ✅ ✅ ✅ ✅ Data point management
DataStream ✅ ✅ ✅ ✅ Data stream management
DeviceCore ✅ ✅ ✅ ✅ Device and selected properties
DeviceInterface ✅ Device and network interface properties
DeviceMetaData ✅ ✅ ✅ ✅ Device descriptor data
DeviceVendor ✅ ✅ Embedded device developer information
DeviceVendorSummary ✅ Device vendor properties
FileData ✅ ✅ ✅ ✅ Data files
FileDataCore ✅ Data files information
FileDataHistory ✅ Data file history information
Group ✅ Device groups
Monitor ✅ ✅ ✅ ✅ Monitors management
NetworkInterface ✅ ✅ ✅ ✅ Device modem list
NetworkInterfaceSubscriptionCore ✅ Carrier subscription information
SCI (Server command interface) ✅ ✅ ✅ ✅ Device-specific commands
XbeeAttributeCore ✅ XBee attributes
XbeeAttributeFull ✅ XBee attributes
XbeeClusterCore ✅ XBee cluster information
XbeeCore ✅ ✅ XBee nodes and properties