DeviceHub

devicehub (le) 342 endpoints in 4 0 x the bulk of litmus edge device configuration, tag creation, browse, asset discovery, plus 292 reference entries (driver examples + register types) run these endpoints open the devicehub folder on api litmus io https //api litmus io/view/2s9y5r1rvg#3384d3cf 13e6 402b 8a25 b67be34f585d sub modules folder endpoints purpose devices 10 device crud + lifecycle (start/stop) drivers 4 list drivers, get driver templates tags 12 tag crud + csv import/export + validation browse 14 bulk tag discovery from a device asset discovery 9 network level asset scanning prometheus metrics 1 metrics scrape endpoint create device driver examples 146 one canonical createdevice per driver register types driver reference 146 supported register types per driver devices (10) graphql on /devicehub/v2 unless noted operation method purpose listdevices post list all configured devices createdevice post create a new device updatedevice post update device properties enable/disable device data storage put toggle persistence per device (rest) deletedevices post delete one or more devices (graphql) delete device rest delete single device delete via rest device discovery tool post opc ua advanced server discovery deviceconnectionstatus post live connection state startdevice post begin polling stopdevice post stop polling drivers (4) operation purpose listdrivergroups driver family tree (start here) getdriver by groupid group level template getdriver by driverid driver template (config + supported registers) list all driver details full dump of all drivers tags (12) operation purpose listallregisters all tags across all devices listregisters tags on one device createregisters create one or more tags updateregisters update tag config deleteregisters delete specific tags delete all tags of a device bulk delete by device browsetags search across configured tags upload tags csv rest file upload download tags csv rest file download registerstatus live tag values + quality server search cross device tag search validateupdateregisters dry run a tag payload (no commit) browse (14) full chain documented in browse bulk tag discovery workflow # key operations createbrowsetask , startbrowsetasks , listbrowsetasks , stopbrowsetask , deletebrowsetask browsetask getfoldersfortreeview , browsetask getfolderitems cart additems , cart updateproperties , cart createallregisters listcartitems , cart getcartitemsbydevice browsetask gettemplate , download browse tags (csv export) asset discovery (9) network level scanning per interface all rest endpoint purpose get /devicehub/assetdiscovery/interfaces list network interfaces get /devicehub/assetdiscovery/devices discovered devices on network get /scan/eth0 , get /scan/wlan0 trigger per interface scan put /enable/eth0 , put /disable/eth0 toggle discovery on eth0 put /enable/wlan0 , put /disable/wlan0 toggle discovery on wlan0 get /scan/nd scan for nd nodes create device driver examples (146) one canonical createdevice mutation per supported driver allen bradley, siemens, modbus variants, opc ua, mqtt, sql clients, sparkplug, plus simulators (generator) use as a copy and adapt reference register types driver reference (146) for each driver, the supported register types (e g modbus tcp holding / input / coil / discrete input) use to validate that the register type you want is allowed before calling createregisters see also devicehub data model # create device + tags workflow #