Have a Question?
HALNy ONT Management APIs — Overview
HALNy ONTs and routers expose three different HTTP-based interfaces for reading (and, in the newest version, writing) device parameters remotely. All three require an OLT with IP-host support (WAN0 for routers), since the ONT is reached through its IP-host interface. Below is a quick comparison so you can pick the right one for your integration — full parameter lists and examples are available at the linked pages for each API version.
1. API (legacy)
Port: 48624
Style: Single GET endpoint, returns a flat list of parameters
Access: “http://IP-HOST-ADDRESS:48624/cgi-bin/api?get=parameter&out=json” (or “xml”)
The original and simplest interface. One call with a “get” parameter (or “get=all”) returns WAN/LAN/WiFi/PON optics/VoIP/system status in a single JSON or XML payload. No write support, no per-function paths — just a snapshot of the device state.
Full documentation: https://halny.com/knowledge-base/api/
2. REST API
Port: 48625
Style: True REST structure — hundreds of individual GET endpoints grouped by function (status, LAN, WiFi 2.4/5GHz, WAN, traffic counters, optics, VoIP, security/bridge filters, multicast/IGMP, NAT/port forwarding, mesh topology)
Access: “http://IP-HOST-ADDRESS:48625/api/v1/URL” — the full endpoint list is self-documented at “/api/v1/help”
A much more granular, read-only API. Every setting and status value has its own path, which makes it easy to poll only what you need instead of parsing one large response.
Full documentation: https://halny.com/knowledge-base/rest-api/
3. REST API V2
Port: 48626
Style: Full REST implementation with GET / POST / DELETE methods — so, unlike the previous two, it also supports writing configuration, not just reading status
Access: “http://IP-HOST-ADDRESS:48626/api/v2/endpoint”, authenticated with username “apiuser” and a password composed of the last 4 characters of the device MAC address + “APIpass”
This is the most capable and actively maintained version. Endpoint reference is published as interactive Postman documentation rather than a static list on the page.
Full documentation: https://halny.com/knowledge-base/rest-api-v2/
Postman collection: https://documenter.getpostman.com/view/29798136/2sA3XSA17c
Which one should I use?
For new integrations, REST API v2 is recommended — it’s the only one that supports configuration changes and is the actively developed version. The older REST API and legacy API remain useful for read-only monitoring on devices/firmware that don’t support v2.