-
-
Notifications
You must be signed in to change notification settings - Fork 1
Providing REST Results
This module makes extensive use of the REST interface to communicate with the ISY. When debugging an issue, or to support development of a new feature, you may be asked to provide the direct results in order to troubleshoot.
The REST XML results can be obtained by visiting the link provided using any browser, entering your login information, and saving the results as an .xml file.
Advanced users can also download the files using curl or wget.
Sometimes it's easier to narrow down errors with loading by just running the python module. From any system with Python >= 3.10 installed (includes just running it inside the Home Assistant container), the following commands will dump the debug log, and output your node information to .yaml files in a directory called .output/:
# If running in the Home Assistant container, skip this step:
python3 -m pip install pyisyox
# Connect to ISY and output details, replace base URL as needed for ISY994, eisy, or IP address
# -v switches to verbose mode, -h will print the full usage info
python3 -m pyisyox http://polisy.local:8080 admin "password" -oFeel free to redact any names in the text that you do not want to share, but in general, I have found that there is no overly-sensitive personal information in these files by their nature, and I do not use them for anything other than troubleshooting. The only file which I have found which I will always ask to redact is the /config endpoint, since this has your GPS location data included.
- UDI General REST Documentation: https://wiki.universal-devices.com/index.php?title=ISY_Developers:API:REST_Interface
- Node Servers, V5 API: https://wiki.universal-devices.com/index.php?title=ISY_Developers:API:V5
| Path | Description |
|---|---|
/rest/config |
Configuration details |
/rest/nodes |
General Node Configurations |
/rest/status |
Detailed Node Statuses |
/rest/time |
Time information |
/rest/programs?subfolders=true |
Program information |
/rest/vars/definitions/1 |
Integer Variable Definitions |
/rest/vars/definitions/2 |
State Variable Definitions |
/rest/vars/get/1 |
Integer Variable Status |
/rest/vars/get/2 |
State Variable Status |
/rest/networking/resources |
Network Resources (requires Network Module or Portal) |
/rest/profiles/ns/0/files |
Node Server Profile File List |
/rest/profiles/download/core |
(.ZIP file) Core Family profile files |
/rest/profiles/files |
Core Family full file list |
/rest/profiles/family/#/files |
Core Family # file list |