-
Notifications
You must be signed in to change notification settings - Fork 0
Http Rest API Overview
Liu Guoping edited this page Jul 18, 2025
·
2 revisions
http rest api server port: 8086
| No. | API Path/Command | Method | Description | Example / Remarks |
|---|---|---|---|---|
| 1 | /api/wifi/status | GET | Query WiFi connection status | |
| 2 | /api/system/info | GET | Query system information | |
| 3 | /api/software/info | GET | Query software version info | |
| 4 | /api/service/info | GET | Query service status | |
| 5 | /api/service/info/{service_name} | GET | Query specific service status | /api/service/info/openhab |
| 6 | /api/zigbee/info | GET | Query Zigbee status | |
| 7 | /api/browser/info | GET | Query browser information | |
| 8 | /api/setting/info | GET | List backup files (timestamps) | |
| 9 | /api/channel/info | GET | Query channel information | |
| 10 | /api/channel/info?type=zigbee | GET | Query Zigbee channel information | |
| 11 | /api/channel/info?type=thread | GET | Query Thread channel information | |
| 12 | /api/task/info | GET | Query background/long tasks | |
| 13 | /api/task/info?task=zigbee | GET | Query Zigbee-related tasks | |
| 14 | /api/task/info?task=setting | GET | Query setting-related tasks | |
| 15 | /api/task/info?task=thread | GET | Query thread-related tasks | |
| 16 | /api/health | GET | Health check | Added by AI |
| 17 | /health | GET | Health check | Added by AI |
| 18 | /api/example/node | GET | Simulate WiFi interference | http://${linuxbox_ip_address}:8086/api/example/file_node?file_path=${file_path_on_linuxbox} |
| 19 | /api/system/command | POST | System commands | command=reboot&_ct=xx&_sig=xx command=factory_reset&_ct=xx&_sig=xx |
| 20 | /api/system/command | POST | Zigbee mode/channel/scan switch | command=zigbee&action=zha/z2m/scan/channel_20 command=zigbee¶m={...} |
| 21 | /api/system/command | POST | Thread channel switch | command=thread&action=channel_20 command=thread¶m={...} |
| 22 | /api/system/command | POST | System backup/restore | command=setting&action=backup command=setting¶m={...} |
| 23 | /api/service/control | POST | Service control (enable/disable/start/stop) | action: enable/disable/start/stop {"package":"homeassistant_core","service":"zigbee2mqtt.service"} |
Note: For complex command parameters, see the detailed examples below.