Local and cloud
Local and cloud
| Home network | Cloud relay | |
|---|---|---|
| Address | https://igh-<serial>.local:8490/v1 (or the gateway's LAN address) |
https://api.igh.app/v1 |
| WebSocket | wss://igh-<serial>.local:8490/v1/stream |
wss://api.igh.app/v1/stream |
| TLS | the gateway's own CA: pin it (TLS and CA pinning) | a public certificate |
| Needs | the same network as the gateway | cloud_access: on, the gateway online |
| Rate limits | none | per home (Rate limits) |
| Body size | — | requests up to 16 KiB; answers up to 4 MiB (too_large) |
Finding the gateway. With mdns: on, each API integration is announced as a _igh-api._tcp service on port 8490, named after the integration, with TXT records v=1, gw=<serial> and record=<integration id>. The serial is the 12-character gateway id shown on the integration's page (lower case in host names).
Plain HTTP is never offered, locally or in the cloud. Every answer carries the header x-igh-api-version: 1.
Through the cloud the request travels over the gateway's own tunnel: nothing about the home is cached in the cloud. When the gateway has no tunnel the answer is 503 gateway_offline; when it doesn't answer within 10 seconds, 504 gateway_timeout. With cloud_access: off the gateway refuses every relayed request with 403 cloud_access_disabled, while the home network keeps working.
IGH home API 1.1.0. Generated from the doc source; do not edit.