IDM User Guide
Version 1.1
Contents:
Installation
Python & Jupyter Support
Hardware - Devices
Arduino IDE Integration
MQTT Client
API Reference
REST API V1 Reference
Service API
IDM User Guide
»
API Reference
API Reference
REST API V1 Reference
Overview
Structure of REST URIs
General
/api/v1/me
/api/v1/me/version
/api/v1/me/servertime
/api/v1/me/arptable
/api/v1/me/activity
Connectivity
/api/v1/me/connections{adapter}
/api/v1/me/serial/{adapter}/{level}
/api/v1/me/bluetooth/{adapter}/{level}
Device Access
/api/v1/me/{device_name}/{substructure}/…/{variable}
/api/v1/me/{device_name}/device_status
Properties
/api/v1/me/{identifier}/properties/{property_name}/{substructure}/…
Services
/api/v1/me/services/{service_name}
/api/v1/me/services/pin/{service_name}
Terminal Remote Commands
/api/v1/terminal/commands
/api/v1/terminal/aliases
/api/v1/terminal/config
User and Group Access Permisions
/api/v1/credentials
/api/v1/credentials/users
/api/v1/credentials/users/pin
/api/v1/credentials/users/register
/api/v1/credentials/groups
/api/v1/credentials/groups/members
/api/v1/manager/device/upgrade
Resource Links, Grouping and Aggregation
Link and group link definition
Link and group link access
Aggregation functions
Vertical record aggregation access
Horizontal record aggregation access
Service API
Data Format
Usage