Skip to content

REST API

All routes are prefixed with /api.

MethodPathDescription
GET/api/statusMQTT connection status + bridge list
GET/POST/api/devicesList / create devices
PUT/api/devices/orderReorder devices
PUT/DELETE/api/devices/{id}Update / delete a device
POST/api/devices/{id}/duplicateDuplicate a device
POST/PUT/DELETE/api/devices/{id}/buttons/{btn_id}Create / update / delete a button
POST/api/devices/{id}/buttons/{btn_id}/triggerSend IR code for a button
POST/api/devices/{id}/buttons/{btn_id}/assign_codeAssign last learned code
GET/api/bridgesList bridges
DELETE/api/bridges/{id}Remove a bridge
PUT/api/bridges/{id}/settingsUpdate bridge settings
POST/api/bridges/{id}/protocolsSet enabled protocols
GET/api/bridges/serial/portsList available serial ports
POST/api/bridges/serialAdd a serial bridge
DELETE/api/bridges/serial/{id}Remove a serial bridge
POST/api/learnStart IR learning (?bridges=…&smart=true)
POST/api/learn/cancelCancel learning
GET/api/irdb/statusIR database status
POST/api/irdb/syncDownload/update IR databases
GET/api/irdb/browseBrowse IR database (?path=…)
GET/api/irdb/searchSearch IR database (?q=…)
GET/api/irdb/fileLoad IR file (?path=…)
POST/api/irdb/send_codeSend a raw IR code (test)
GET/POST/PUT/DELETE/api/automations{/id}CRUD for automations
POST/api/automations/{id}/triggerManually trigger an automation
GET/PUT/api/settings/appApp mode + topic style
GET/PUT/api/settings/mqttMQTT broker settings
POST/api/settings/mqtt/testTest MQTT connection
PUT/api/settings/log_levelSet log level
GET/POST/api/config/export, /api/config/importBackup / restore config
POST/api/resetFactory reset
POST/DELETE/api/test/loopbackStart / stop loopback hardware test