{"info":{"_postman_id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","name":"HALNy REST API V2","description":"

REST API for HALNy devices.

Available in software series:

V3.2.50p1
\n
V5.0.16p1
\n
V4.0.11
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29798136","collectionId":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","publishedId":"2sA3XSA17c","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-29T14:16:45.000Z"},"item":[{"name":"GET","item":[{"name":"STATUS","id":"12ebc478-abb1-4622-9d9e-ba1d38230bf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{ont_ip}}:48626/api/v2/status","description":"

Get Status

This endpoint retrieves the status information of the ONT (Optical Network Terminal).

Response

The response will contain the following information in a JSON format:

restapi_version - The version of the REST API.
\n
ont_model_name - The model name of the ONT.
\n
ont_hw_version - The hardware version of the ONT.
\n
ont_gpon_serial_nr - The serial number of the ONT in alphanumeric format.
\n
ont_gpon_hex_serial_nr - The serial number of the ONT in hexadecimal format.
\n
ont_mac - The MAC address of the ONT.
\n
active_firmware_ver - The active firmware version of the ONT.
\n
standby_firmware_ver - The standby firmware version of the ONT.
\n
uptime - The duration for which the ONT has been running.
\n
olt_id - The ID of the OLT (Optical Line Terminal).
\n
ont_id - The ID of the ONT.
\n
service_mode (string): The service mode of the ONT.
\n
optic_rx_power - The received optical power level.
\n
optic_tx_power - The transmitted optical power level.
\n

This endpoint makes an HTTP GET request to retrieve the device condition data

Response

The response will contain the following information in a JSON format.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_pass}}"}]},"isInherited":true,"source":{"_postman_id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","name":"HALNy REST API V2","type":"collection"}},"urlObject":{"protocol":"http","port":"48626","path":["api","v2","device_condition"],"host":["{{ont_ip}}"],"query":[],"variable":[]}},"response":[{"id":"5bc9a1a7-933d-4ede-bc75-1112ed8e3b97","name":"DEVICE_CONDITION","originalRequest":{"method":"GET","header":[],"url":"http://{{ont_ip}}:48626/api/v2/device_condition"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Length","value":"8134"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 06 Feb 2024 14:39:09 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"reboot_reason\": {\n \"0\": {\n \"date\": \"1970-01-01 01:37:13-GMT+01:00\",\n \"reboot_reason\": \"Auto Provision (Provisioning)\"\n },\n \"1\": {\n \"date\": \"1970-01-02 02:16:51-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"2\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"3\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"4\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"5\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"6\": {\n \"date\": \"2025-08-04 10:34:41-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"7\": {\n \"date\": \"1970-01-01 01:11:12-GMT+01:00\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"8\": {\n \"date\": \"2025-08-01 13:42:02-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"9\": {\n \"date\": \"1970-01-01 01:21:45-GMT+01:00\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"10\": {\n \"date\": \"1970-01-01 01:01:48-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"11\": {\n \"date\": \"1970-01-01 01:07:37-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"12\": {\n \"date\": \"1970-01-01 01:02:36-GMT+01:00\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"13\": {\n \"date\": \"1970-01-01 01:05:47-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"14\": {\n \"date\": \"1970-01-01 01:02:32-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"15\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"16\": {\n \"date\": \"1970-01-01 02:13:43-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"17\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"18\": {\n \"date\": \"1970-01-01 00:00:16-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"19\": {\n \"date\": \"1970-01-01 01:02:35-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"20\": {\n \"date\": \"1970-01-01 01:07:18-GMT+01:00\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"21\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"22\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"23\": {\n \"date\": \"1970-01-01 01:04:44-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"24\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"25\": {\n \"date\": \"1970-01-01 01:04:56-GMT+01:00\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"26\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"27\": {\n \"date\": \"2025-07-29 13:57:00-GMT+01:00\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"28\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"29\": {\n \"date\": \"1970-01-01 01:01:53-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"30\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"31\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"32\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"33\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"34\": {\n \"date\": \"1970-01-01 01:13:30-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"35\": {\n \"date\": \"1970-01-01 01:02:16-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"36\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"37\": {\n \"date\": \"1970-01-01 02:35:04-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"38\": {\n \"date\": \"1970-01-01 01:08:03-GMT+01:00\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"39\": {\n \"date\": \"1970-01-01 00:00:16-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"40\": {\n \"date\": \"1970-01-01 00:00:16-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"41\": {\n \"date\": \"2025-07-23 14:31:28-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"42\": {\n \"date\": \"1970-01-01 01:02:50-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"43\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"44\": {\n \"date\": \"2025-07-15 09:43:34-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"45\": {\n \"date\": \"2025-15-07 09:36:49-GMT+01:00\",\n \"reboot_reason\": \"Auto Reboot (OTT)\"\n },\n \"46\": {\n \"date\": \"1970-01-01 01:05:45-GMT+01:00\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"47\": {\n \"date\": \"2025-07-09 15:29:00-GMT+00:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"48\": {\n \"date\": \"1970-01-01 00:00:26-GMT+01:00\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"49\": {\n \"date\": \"2025-07-09 15:22:04-GMT+00:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"50\": {\n \"date\": \"1970-01-01 00:00:17-GMT+00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"51\": {\n \"date\": \"1970-01-01 00:00:26-GMT+01:00\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"52\": {\n \"date\": \"2025-07-09 15:12:50-GMT+00:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"53\": {\n \"date\": \"2025-07-09 15:03:14-GMT+00:00\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"54\": {\n \"date\": \"1970-01-01 00:00:27-GMT+01:00\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"55\": {\n \"date\": \"2025-07-09 14:58:12-GMT+00:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"56\": {\n \"date\": \"1970-01-01 00:00:17-GMT+00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"57\": {\n \"date\": \"1970-01-01 00:00:27-GMT+01:00\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"58\": {\n \"date\": \"1970-01-01 03:28:33-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"59\": {\n \"date\": \"1970-01-01 00:00:16-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"60\": {\n \"date\": \"1970-01-01 02:03:27-GMT+02:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"61\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"62\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"63\": {\n \"date\": \"1970-01-01 02:03:36-GMT+02:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"64\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"65\": {\n \"date\": \"1970-01-01 02:05:07-GMT+02:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"66\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"67\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"68\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"69\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"70\": {\n \"date\": \"1970-01-01 02:02:36-GMT+02:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"71\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"72\": {\n \"date\": \"1970-01-01 02:02:24-GMT+02:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"73\": {\n \"date\": \"1970-01-01 00:00:18-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"74\": {\n \"date\": \"1970-01-01 00:00:17-GMT+02:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"75\": {\n \"date\": \"1970-01-01 00:00:16-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"76\": {\n \"date\": \"1970-01-01 03:39:09-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"77\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"78\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"79\": {\n \"date\": \"1970-01-01 01:01:41-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"80\": {\n \"date\": \"2025-06-30 08:58:54-GMT+01:00\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"81\": {\n \"date\": \"1970-01-01 01:22:56-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"82\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"83\": {\n \"date\": \"2025-06-27 06:38:26-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"84\": {\n \"date\": \"2025-06-27 06:18:09-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"85\": {\n \"date\": \"2025-06-27 06:09:47-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"86\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"87\": {\n \"date\": \"1970-01-01 01:05:41-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"88\": {\n \"date\": \"1970-01-01 01:42:30-GMT+01:00\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"89\": {\n \"date\": \"2025-06-26 12:37:42-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"90\": {\n \"date\": \"1970-01-01 00:00:16-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"91\": {\n \"date\": \"2025-06-26 12:13:51-GMT+01:00\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"92\": {\n \"date\": \"1970-01-01 01:12:42-GMT+01:00\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"93\": {\n \"date\": \"2025-06-26 11:46:52-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"94\": {\n \"date\": \"1970-01-01 00:00:16-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"95\": {\n \"date\": \"1970-01-01 00:00:16-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"96\": {\n \"date\": \"1970-01-01 01:02:07-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"97\": {\n \"date\": \"1970-01-01 00:00:17-GMT+01:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"98\": {\n \"date\": \"2025-06-26 10:45:04-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"99\": {\n \"date\": \"1970-01-01 01:01:58-GMT+01:00\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n }\n }\n}"}],"_postman_id":"a1179318-2093-4d74-bedd-38cc27c91c4d"},{"name":"DEVICE_CONDITION_REBOOT_REASON","id":"922b8385-68aa-4f28-bd1c-29c6815f3dd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{ont_ip}}:48626/api/v2/device_condition/reboot_reason","description":"

This endpoint retrieves the status information of the ONT reboot reason.

Response

The response will contain the following information in a JSON format:

entry_id (0...99)
\n
date: the date of event
\n
reboot_reason: reason of ONT reboot
\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_pass}}"}]},"isInherited":true,"source":{"_postman_id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","name":"HALNy REST API V2","type":"collection"}},"urlObject":{"protocol":"http","port":"48626","path":["api","v2","device_condition","reboot_reason"],"host":["{{ont_ip}}"],"query":[],"variable":[]}},"response":[{"id":"b57d7587-ec18-4718-bdbb-5c5615435202","name":"DEVICE_CONDITION_REBOOT_REASON","originalRequest":{"method":"GET","header":[],"url":"http://{{ont_ip}}:48626/api/v2/device_condition/reboot_reason"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Length","value":"8116"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 06 Feb 2024 14:39:22 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"0\": {\n \"date\": \"2024-02-06 14:20:03-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"1\": {\n \"date\": \"2024-02-06 14:05:58-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"2\": {\n \"date\": \"2024-02-06 09:43:33-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"3\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"4\": {\n \"date\": \"2024-02-05 15:47:14-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"5\": {\n \"date\": \"2024-02-05 15:00:03-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"6\": {\n \"date\": \"2024-02-05 09:00:26-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"7\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"8\": {\n \"date\": \"2024-02-02 17:07:52-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"9\": {\n \"date\": \"1970-01-01 01:01:54-\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"10\": {\n \"date\": \"2024-02-02 16:16:53-\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"11\": {\n \"date\": \"2024-02-02 16:00:28-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"12\": {\n \"date\": \"2024-02-02 15:26:06-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"13\": {\n \"date\": \"2024-02-02 13:54:38-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"14\": {\n \"date\": \"2024-02-02 13:12:12-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"15\": {\n \"date\": \"2024-02-02 11:35:32-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"16\": {\n \"date\": \"2024-02-02 10:31:33-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"17\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"18\": {\n \"date\": \"2024-02-01 15:42:57-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"19\": {\n \"date\": \"2024-02-01 15:17:29-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"20\": {\n \"date\": \"2024-02-01 14:35:23-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"21\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"22\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"23\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"24\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"25\": {\n \"date\": \"2024-01-30 12:20:09-\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"26\": {\n \"date\": \"30 01 2024 11:52\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"27\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"28\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"29\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"30\": {\n \"date\": \"01 01 1970 01:03\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"31\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"32\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"33\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"34\": {\n \"date\": \"1970-01-01 06:22:24-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"35\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"36\": {\n \"date\": \"2024-01-29 08:23:30-\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"37\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"38\": {\n \"date\": \"2024-01-26 10:53:54-\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"39\": {\n \"date\": \"2024-01-26 08:48:14-\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"40\": {\n \"date\": \"2024-01-26 08:42:14-\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"41\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"42\": {\n \"date\": \"1970-01-01 01:07:27-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"43\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"44\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"45\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"46\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"47\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"48\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"49\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"50\": {\n \"date\": \"1970-01-01 00:00:17-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"51\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"52\": {\n \"date\": \"2024-01-16 15:07:52-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"53\": {\n \"date\": \"2024-01-16 14:50:01-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"54\": {\n \"date\": \"2024-01-16 14:28:28-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"55\": {\n \"date\": \"1970-01-01 00:00:16-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"56\": {\n \"date\": \"1970-01-01 02:12:08-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"57\": {\n \"date\": \"2024-01-16 09:04:13-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"58\": {\n \"date\": \"2024-01-16 08:49:13-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"59\": {\n \"date\": \"2024-01-16 08:36:36-\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"60\": {\n \"date\": \"1970-01-01 00:00:17-\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"61\": {\n \"date\": \"15 01 2024 14:01\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"62\": {\n \"date\": \"15 01 2024 13:35\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"63\": {\n \"date\": \"12 01 2024 12:52\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"64\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"65\": {\n \"date\": \"11 01 2024 12:47\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"66\": {\n \"date\": \"11 01 2024 11:01\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"67\": {\n \"date\": \"11 01 2024 10:33\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"68\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"69\": {\n \"date\": \"11 01 2024 10:07\",\n \"reboot_reason\": \"User Factory Restore (reboot_type 10)\"\n },\n \"70\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"71\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"72\": {\n \"date\": \"10 01 2024 14:20\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"73\": {\n \"date\": \"10 01 2024 13:23\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"74\": {\n \"date\": \"10 01 2024 13:17\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"75\": {\n \"date\": \"01 01 1970 01:04\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"76\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"77\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"78\": {\n \"date\": \"01 01 1970 01:16\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"79\": {\n \"date\": \"01 01 1970 02:06\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"80\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"81\": {\n \"date\": \"01 01 1970 02:27\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"82\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"83\": {\n \"date\": \"01 01 1970 02:13\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"84\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"85\": {\n \"date\": \"01 01 1970 02:01\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"86\": {\n \"date\": \"01 01 1970 02:03\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"87\": {\n \"date\": \"01 01 1970 04:14\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"88\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"89\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"90\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"91\": {\n \"date\": \"28 10 2023 13:35\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"92\": {\n \"date\": \"08 01 2024 08:29\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"93\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n },\n \"94\": {\n \"date\": \"05 01 2024 17:11\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"95\": {\n \"date\": \"01 01 1970 01:04\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"96\": {\n \"date\": \"01 01 1970 02:06\",\n \"reboot_reason\": \"SW Reboot by Active Image Change\"\n },\n \"97\": {\n \"date\": \"01 01 1970 01:06\",\n \"reboot_reason\": \"Web System Reboot\"\n },\n \"98\": {\n \"date\": \"05 01 2024 14:32\",\n \"reboot_reason\": \"Factory Restore (reboot_type 2)\"\n },\n \"99\": {\n \"date\": \"01 01 1970 00:00\",\n \"reboot_reason\": \"Power Reboot (Unknown)\"\n }\n}"}],"_postman_id":"922b8385-68aa-4f28-bd1c-29c6815f3dd4"},{"name":"OPTIC","id":"727b3de8-6095-4765-8c1b-1063f2abae49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{ont_ip}}:48626/api/v2/optic","description":"

Get Optic Information

This endpoint retrieves the optic information from the specified device.

Response

The response will contain the following information in a JSON format:

link_status - Indicates the status of the link, whether it is \"UP\" or \"DOWN\".
mode - Specifies the mode of the optic, such as \"GPON\" or \"EtherWAN\".
rx_power - Represents the received power level in dBm.
tx_power - Indicates the transmitted power level in dBm.
supply_voltage - Shows the supply voltage in volts.
tx_bias_current - Specifies the bias current for transmission in mA.
temperature - Represents the temperature in Celsius.

This endpoint makes an HTTP GET request to retrieve information about LAN hosts. The response provides details about each LAN host, including their activity status, MAC address, port, hostname, IP address, address origin, link rate, duplex, power level, lease time, online time, last active date, and last inactive date.

Response

The response will contain the following information in a JSON format:

active - online/offline host status indicator
mac_address - MAC address of the host
port - port of ONT where host is connected to
hostname - host hostname
ip_address - IP address of host
address_origin - IP address obtain method
link_rate - link rate in kb/s
duplex - duplex mode
power_level - power level - applies only to wireless connection
lease_time - IP addreas lease time, format \"day:hours:minutes\"
online_time - summary time when host was online in seconds
last_active_date - date and hour when host went online
last_inactive_date - date and hour when host went ofline

This endpoint makes an HTTP GET request to retrieve the counters related to LAN and WLAN data transmission. The response includes the sum of received and transmitted data for LAN and WLAN, along with the individual data for each LAN and WLAN channel.

This endpoint makes an HTTP GET request to retrieve software information. The request does not include a request body.

This endpoint makes an HTTP GET request to retrieve information about the WAN (Wide Area Network) interfaces. The response will include details about the active WAN interface number and the status of each interface, including whether it is enabled, the connection type, MAC address, IP address, netmask, gateway, DNS servers, PPP login, PPP password, and PPP status for each interface.

WAN Information

This endpoint retrieves the WAN (Wide Area Network) information for a specific WAN connection.

Response

The response will contain the following information in a JSON format:

enabled: The status of the WAN connection.
\n
conn_type: The type of connection (e.g., DHCP, Static IP).
\n
service_type: The service type of connection (e.g., INTERNET, IPTV, VoIP)
\n
mode: The type of connection (e.g., ROUTER, BRIDGE)
\n
dot1q: VLAN tagging mode for the interface
\n
vlan_id: VLAN ID assigned to the WAN connection
\n
cos: Class of Service value
\n
mtu: MTU in bytes for the interface
\n
ip_version: The IP version of interface
\n
mac: The MAC address of the WAN interface.
\n
ip: The IP address assigned to the WAN interface.
\n
netmask: The netmask of the WAN interface.
\n
gateway: The gateway IP address for the WAN connection.
\n
dns1: The primary DNS server IP address.
\n
dns2: The secondary DNS server IP address.
\n
nat_enable: Indicates whether Network Address Translation (NAT) is enabled
\n
ipv6_dhcp_mode: The method used to obtain IPv6 address
\n
ipv6_gw_mode: The metod used to configure the IPv6 gateway
\n
ipv6_dhcp_pd_enable: Indicates if IPv6 Prefix Delegation is enabled
\n
dad_enable: Indicates if Duplicate Address Detection (DAD) is enabled
\n
igmp_proxy_enable: Inficates if IGMP Proxy is enabled
\n
dhcp_opt82_enable: Indicates if DHCP option 82 is enabled
\n
dhcp_opt82_circuit_id: The Circuit ID string used in DHCP Option82
\n
dhcp_opt82_remote_id: Remote ID string used in DHCP Option82
\n
dhcp_opt60_enable: Indicates if DHCP Option 60 is enabled
\n
dhcp_opt60_value: The Vendor Class Identifier string used in DHCP option 60
\n
ppp_login: The PPP login information (if applicable).
\n
ppp_password: The PPP password information (if applicable)
\n
ppp_status: The status of the PPP connection (if applicable)
\n
ppp_babyjumbo_enable: Indicates if PPP baby Jumbo frames are enabled (if applicable)
\n

This endpoint makes an HTTP GET request to retrieve the WAN port binding information from the specified device.

The response will include the status of LAN ports 1 to 4, as well as the status of the 2.4GHz and 5GHz Wi-Fi SSIDs 1 to 4.

Retrieve WAN port binding information

This endpoint makes an HTTP GET request to retrieve the WAN port binding information from the specified device.

The response will include the status of LAN ports 1 to 4, as well as the status of the 2.4GHz and 5GHz Wi-Fi SSIDs 1 to 4.

This endpoint makes an HTTP GET request to retrieve LAN configuration information. The response will include details such as the IP address, netmask, DHCP settings, DNS settings, and the status and mode of each port.

This endpoint makes an HTTP GET request to retrieve information about LAN settings for a specific LAN port.

Response

The response will be in JSON format with the following fields:

type (string): The type of LAN connection.
\n
enabled (string): Indicates whether the LAN port is enabled or disabled.
\n
oper_state (string): The operational state of the LAN port.
\n
mode (string): The mode of the LAN connection.
\n

WLAN24 Configuration

This endpoint allows you to retrieve the configuration details for the 2.4GHz WLAN.

Request

The response will contain the following parameters:

enable (string): Indicates whether the WLAN is enabled.
mode (string): Specifies the mode of the WLAN.
channel_selection (string): Indicates the method of channel selection.
channel (string): Specifies the channel used by the WLAN.
channel_width (string): Indicates the channel width configuration.
country (string): Specifies the country code for WLAN operation.
tx_power (string): Indicates the transmission power level.
min_rssi_sta_connect : The minimum RSSI level for a station to connect to the AP
min_rssi_sta_disconnect: The minimum RSSI level for AP to disconnect the station

The ssid object contains the configuration details for individual SSIDs, each identified by a numeric key. For each SSID, the following parameters are included:

state (string): Indicates the state of the SSID (activated/deactivated).
hidden (string): Specifies if the SSID is hidden.
wps_enable (string): Indicates whether WPS is enabled for the SSID.
prefix (string): Specifies the prefix for the SSID name.
ssid_name (string): Specifies the name of the SSID.
password (string): Indicates the password for the SSID.
security (string): Specifies the security protocol used for the SSID.
encryption (string): Indicates the encryption method used for the SSID.

This HTTP GET request retrieves information about a specific 2.4GHz WLAN SSID by its ID.

Upon a successful execution, the response will have a status code of 200, and it will contain the following information in JSON format:

state: The activation state of the WLAN.
hidden: Indicates if the SSID is hidden or not.
wps_enable: Indicates if WPS (Wi-Fi Protected Setup) is enabled.
prefix: The prefix of the SSID.
ssid_name: The name of the SSID.
password: The password for the SSID.
security: The security protocol used for the SSID.
encryption: The encryption method used for the SSID.

Retrieve WLAN5 Configuration

This endpoint makes an HTTP GET request to retrieve the configuration details of WLAN5.

mode: The mode of the WLAN5 (e.g. 802.11n/ac/ax)
enable: Indicates whether WLAN5 is enabled or not
channel_selection: The method used for channel selection (e.g. AUTO)
channel_width: The width of the channel (e.g. 80MHz)
dfs_enable: Indicates whether DFS (Dynamic Frequency Selection) is enabled or not
country: The country code for WLAN5
channel: The channel number
tx_power: The transmission power level
min_rssi_sta_connect : The minimum RSSI level for a station to connect to the AP
min_rssi_sta_disconnect: The minimum RSSI level for AP to disconnect the station

SSID Configuration

The ssid object contains the configuration details for individual SSIDs, each identified by a numeric key. For each SSID, the following parameters are included:

state: The state of the SSID (e.g. ACTIVATED, DEACTIVATED)
hidden: Indicates whether the SSID is hidden or not
wps_enable: Indicates whether WPS (Wi-Fi Protected Setup) is enabled or not
prefix: The prefix for the SSID
ssid_name: The name of the SSID
password: The password for the SSID
security: The security protocol used for the SSID (e.g. WPA2PSKWPA3PSK, WPA2PSK)
encryption: The encryption method used for the SSID (e.g. AES)

This HTTP GET request retrieves information about the settings for the wireless network SSID 1. The response includes details such as the state of the network, whether it is hidden, WPS (Wi-Fi Protected Setup) enablement, prefix, SSID name, password, security type, and encryption method.

The response will contain the following parameters:

state: The state of the wireless network (e.g., \"ACTIVATED\").
\n
hidden: Indicates whether the network is hidden (e.g., \"NO\").
\n
wps_enable: Indicates if WPS is enabled (e.g., \"YES\").
\n
prefix: The prefix for the SSID (e.g., \"TEST5-\").
\n
ssid_name: The name of the SSID (e.g., \"TEST5-SSID-1\").
\n
password: The password for the network (e.g., \"wifipass5\").
\n
security: The security type used for the network (e.g., \"WPA2PSKWPA3PSK\").
\n
encryption: The encryption method used (e.g., \"AES\").
\n

This endpoint makes an HTTP GET request to retrieve information about WLAN mesh from the specified URL. The request does not require any payload in the raw request body. Upon successful execution, the response will include the status code 200 along with the details of WLAN mesh, such as enable status, device role, fast roaming enable status, and fast roaming type.

The response will contain the following fields:

enable (string): Indicates whether WLAN mesh is enabled or not.
device_role (string): Specifies the role of the device in the WLAN mesh.
fast_roaming_enable (string): Indicates whether fast roaming is enabled or not.
fast_roaming_type (string): Specifies the type of fast roaming.

This endpoint makes an HTTP GET request to retrieve VoIP configuration information. The response includes details such as line status, register status, login credentials, codec, bind interface, region, register server, port, registration expiration, DTMF settings, and digit map. The status code for a successful execution is 200.

Get VoIP Line Information

This endpoint retrieves information about a specific VoIP line.

The response will contain the following fields:

line_status: The current operational state of VoIP line
\n
register_status: The SIP registration status with the VoIP server
\n
login: The SIP username
\n
password: The sip authentication password
\n
codec: The audio codec used for VoIP calls
\n

This endpoint retrieves information about a call controlling functions, of a specific VoIP line.

The response returns the status of the warm line, 3-party service, call waiting, and current settings of a warm line number or timeout, caller ID mode, hook flash time intervals.

The response will contain the following fields:

warm_line_enable: Indicates if the warm line feature is enabled
\n
warm_line_number: The phone number for warm line
\n
warm_line_timeout: The delay time before the warm line number is dialed
\n
three_party_service_enable: Indicates if three-party calling is enabled
\n
caller_id_mode: The signaling method used to send Caller ID information
\n
min_flash_hook_time_interval: Minimum acceptable duration of the flash hook signal (ms)
\n
max_flash_hook_time_interfval: Maximum acceptable duration of the flash hook signal (ms)
\n
min_flash_hook_time_release: Minimum release time between flash hook presses (ms)
\n
call_waiting_enable: Indicates if call waiting service is enabled
\n
silence_suppresion_enable: Indicates if silence suppresion is enabled
\n

This endpoint retrieves system information including uptime, memory usage, and load average.

The response includes the following fields:

uptime: The system uptime in days and time.
memory_usage: The percentage of memory usage.
load_average: The system load average.

This HTTP GET request retrieves the rate limit configuration from the specified endpoint. The response includes information such as the enable status, type, setby, and the downstream and upstream values for different classes of service (COS). The response provides a detailed breakdown of the downstream and upstream values for each COS, allowing users to understand the rate limit configuration for different classes.

This endpoint makes an HTTP GET request to retrieve rate limit information for a specific class of service (COS) at the specified IP address and port. The response will include the downstream and upstream rate limit values for the specified COS.

The response includes the following fields:

downstream:Rate limit set in downstream direction
\n
upstream: Rate limit set in upstream direction
\n

This endpoint makes an HTTP GET request to retrieve syslog configuration information from the specified IP address and port. The response will include the current configuration for remote syslog, including the remote enable status, remote IP address, and remote port.

This endpoint makes an HTTP GET request to retrieve the management configuration details from the specified IP address and port. The response includes information such as passwords, time settings, web access configuration, and access control list (ACL) details. The passwords object contains admin and user password information, the time object includes time zone and NTP server details, and the web object provides WAN and LAN web access settings along with ACL details.

The response may include the values for admin and user passwords, time zone, NTP server, WAN and LAN web access settings, and ACL details. The ACL object contains up to 10 entries with IP address and net mask information, along with an ACL enable flag.

This endpoint makes an HTTP GET request to retrieve the passwords for the admin and user. The response will include the admin password and the user password.

This endpoint makes an HTTP GET request to retrieve the time management information from the specified server. The response will include the time zone and NTP server details.

Response

time_zone (string): The time zone configuration.
ntp_server1 (string): The NTP server configuration.

This endpoint makes an HTTP GET request to retrieve management web settings. The response includes information such as WAN port, HTTPS access enable status, WAN HTTPS port, IP host port, IP host HTTPS port, LAN web access enable status, and access control list (ACL) details including IP addresses and net masks for up to 10 ACL entries, as well as ACL enable status.

This endpoint retrieves the Access Control List (ACL) configuration for web management. The ACL configuration includes IP addresses and net masks for up to 10 entries, along with the status of ACL enablement.

The response will contain the ACL configuration entries, where each entry includes an \"ip_address\" and \"net_mask\" field. Additionally, the response will include the status of ACL enablement denoted by the \"acl_enable\" field.

wan_mgmt_enable: Indicates if remote management of the device via the WAN interface is enabled
\n
wan_port: The TCP port used for web access via the WAN interface
\n
https_access_enable: Indicates if HTTPS access to the device’s web interface is enabled
\n
wan_https_port: The TCP port used for HTTPS access via the WAN interface
\n
iphost_port: The TCP port used for HTTP access to the IP-host interface
\n
iphost_https_port: The TCP port used for HTTPS access to the IP-host interface
\n
lan_web_access_enable: Indicates if access to the web interface from the LAN is enabled
\n
web_language: The language used in the device’s web interface
\n

This HTTP GET request retrieves the security settings from the specified endpoint. The request does not require any payload in the raw request body.

The response provides various security settings, including storm control, LAN rogue DHCP filter, bridge filters, and their respective enable/disable status and configurations.

This HTTP GET request retrieves the current configuration settings for bridge filtering from the specified endpoint. The response will include various parameters such as enable status, upstream and downstream block settings for IPv6, multicast, flow control, NetBIOS, STP, and storm control.

This HTTP GET request retrieves information related to multicast settings from the specified endpoint. The request does not require any payload in the raw request body.

The response provides details about the IGMP snooping enable status, IGMP LAN isolation, and a list of multicast groups. Each multicast group includes information such as the multicast IP, LAN port, reporter MAC address, VLAN, and whether the multicast is in use.

This endpoint makes an HTTP GET request to retrieve the NAT configuration from the specified IP address and port. The response will contain the NAT configuration details.

Get DMZ information.

Get NAT config - ALG.

Get port forwarding rule ID

active: Indicates if the port forwarding rule is currently active

protocol: The network protocol used for the rule (e.g., TCP, UDP)

name: A descriptive name assigned to the port forwarding rule.

nat_loopback_enabled: Indicates if NAT loopback is enabled

wan_start_port: The starting external (WAN) port number for the rule

wan_end_port: The ending external (WAN) port number for the rule

local_ip: The internal (LAN) IP address of the device to which traffic is forwarded

lan_start_port: The starting internal (LAN) port number for the rule

lan_end_port: The ending internal (LAN) port number for the rule

This endpoint makes an HTTP GET request to retrieve the routing table configuration from the specified IP address and port. The response will contain routing routes details, including destination networks, gateways, interfaces, and route metrics.

GET XML provisioning status

This HTTP GET request retrieves information related to mesh agent upgrades from the specified endpoint. The request does not require a request body.

The response to the request returns a status code of 200, along with a JSON object containing details about mesh agent upgrades. The response includes information such as enable status and details for multiple mesh agent upgrades, including model name, firmware version, server type, server address, server login, server password, file name, and reboot time.

This endpoint makes an HTTP GET request to retrieve information related to mesh agent upgrade.

The response to the last call returned a status code of 200 along with a JSON object containing the following key-value pairs:

model_name:The model name of the device to be upgraded
\n
firmware_version: The target firmware version for the upgrade
\n
server_type: The type of server hosting the firmware file
\n
server_address: The IP address or hostname of the server hosting the firmware file
\n
server_login: The username required to authenticate with the firmware server
\n
server_password: The password required to authenticate with the firmware server
\n
file_name: The name of the firmware file
\n
reboot_time: The scheduled time for the device to reboot and apply the upgrade
\n

Retrieve Mesh Network Topology

This endpoint makes an HTTP GET request to retrieve the mesh network topology details.

Response

update: Indicates if an \"update\" POST has been sent
\n
agents_number: The number of agents in the network.
\n
controller: Details of the controller device including model name, IP, MAC address, firmware version, root distance, and number of connected stations (STA).
\n
agent: Details of the agent devices in the network, including model name, IP, MAC address, firmware version, root distance, and number of connected stations. It also includes backhaul details such as parent MAC, medium, link rate, RSSI, and packet transmission statistics.
\n

This HTTP GET request retrieves the synchronization information for mesh agents from the specified endpoint. The response includes details about the controller and the mesh agents, such as fast roaming settings, steering enable status, WLAN country, WMM (Wi-Fi Multimedia) enable status, and synchronization status.

Response

The response will contain the following information in a JSON format:

controller: Contains information about the controller, including fast roaming settings, steering enable status, WLAN country, and WMM enable status.
- fast_roaming_enable - The status of fast roaming enable for the controller.
- fast_roaming_type - The type of fast roaming for the controller.
- steering_enable - The status of steering enable for the controller.
- wlan5_country - The country code for WLAN5 for the controller.
- wmm_enabled - The status of WMM enable for the controller.
\n
agents: Contains details about the mesh agents, including their synchronization status and error codes.
- agent_0 - Details about the first mesh agent, including its active status, MAC address, IP address, fast roaming settings, steering enable status, WLAN country, WMM enable status, synchronization status, error code, and configuration saved but not rebooted status.
  - active - The active status of the agent.
  - mac - The MAC address of the agent.
  - ip - The IP address of the agent.
  - fast_roaming_enable - The status of fast roaming enable for the agent.
  - fast_roaming_type - The type of fast roaming for the agent.
  - steering_enable - The status of steering enable for the agent.
  - wlan5_country - The country code for WLAN5 for the agent.
  - wmm_enabled - The status of WMM enable for the agent.
  - synchronized - The synchronization status of the agent.
  - error_code - The error code, if any, for the agent.
  - config_saved_not_rebooted - The status indicating whether the configuration is saved but not rebooted for the agent.
  \n
\n

This HTTP GET request retrieves the information of VIDEO parameters.

Response

The response will contain the following information in a JSON format:

status_oper: The current operational status of the RF interface
\n
status_admin: The administrative status of the RF interface
\n
optic_power: The received optical power level, measured in dBm
\n
output_power: The RF output power level, measured in dBµV
\n
temperature: The operating temperature of the RF module, measured in °C
\n

Get all ONT/Router config

The following are the currently supported GET methods, with each returned value being of type string (except /counter node).

\n","_postman_id":"78e2916a-fbf1-414f-8f4f-219ba8076bfd","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_pass}}"}]},"isInherited":true,"source":{"_postman_id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","name":"HALNy REST API V2","type":"collection"}}},{"name":"POST","item":[{"name":"COMMANDS","id":"a9c9cd90-7575-4ab2-99e6-ebcaaf5a5dbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"factory_defaults\":\"now\"}","options":{"raw":{"language":"json"}}},"url":"http://{{ont_ip}}:48626/api/v2/commands/factory_defaults","description":"

This endpoint makes an HTTP POST request to run special command on the device. Supported comands:

reboot: value now
\n
restore_factory
\n
user_factory_defaults
\n
save_config
\n

This endpoint makes an HTTP POST request to set specific WAN configuration. The request should include a JSON payload in the raw request body type:

enabled:(yes|no) - Indicates the WAN connection state.
\n
conn_type: (dhcp|static|ppoe|bridge)- Specifies the type of WAN connection.
\n
mode: (router|bridge)- Defines the mode of the WAN connection.
\n
service_type: (internet|internet-voip|voip|iptv|other|tr069_internet| tr069_voip_internet) - Specifies the type of service for the WAN connection.
\n
ip_version: (ipv4|ipv6|ipv4/ipv6) - Indicates the IP version used for the WAN connection.
\n
dot1q: (tag/untag) - Specifies whether 802.1Q VLAN tagging is enabled.
\n
vlan_id: (1-4096) - Specifies the VLAN ID for the WAN connection.
\n
cos: (0-7)- Specifies the Class of Service for the WAN connection.
\n
nat_enable:(yes|no) - Indicates the NAT state
\n
ip:(x.x.x.x) - Specifies IPv4 address
\n
netmask: (x.x.x.x) - Specifies the IPv4 netmask
\n
gateway: (x.x.x.x) - Specifies the IPv4 gateway address
\n
dns1: (x.x.x.x), Specifies primary DNS IPv4 adress
\n
dns2: (x.x.x.x) - Specifies secondary DNS IPv4 address
\n
ppp_login : (1-16 characters) - Specifies the PPPoE login string
\n
ppp_password: (1-15 characters) - Specifies the PPPoE password string
\n
ppp_babyjumbo_enable:(yes|no) - Indicates the PPPoE Baby Jumbo feature state
\n
mtu: (DHCP-1500, PPPoE-1492) - Specifies the MTU size
\n
igmp_proxy_enable: (yes|no) - Indicates the IGMP proxy state
\n
dhcp_opt82_enable: (yes|no) - Indicates the DHCP option 82 state
\n
dhcp_opt82_circuit_id:(0-20 characters) - Specifies the DHCP option 82 circuit string
\n
dhcp_opt82_remote_id:(0-20 characters) - Specifies the DHCP option 82 remote string
\n
dhcp_opt60_enable: (yes|no) - Indicates the DHCP option 60 state
\n
dhcp_opt60_value:(0-20 characters) - Specifies the DHCP option 60 string
\n
ip6_dhcp_mode: (DHCP|SLAAC) - Indicates method used to obtain IPv6 address
\n
ipv6_gw_mode: (AUTO|MANUAL) - Indicates metod used to configure the IPv6 gateway
\n
ipv6_dhcp_pd_enable: (yes|no) - Indicates IPv6 Prefix Delegation state
\n
dad_enable: (yes|no) - Indicates if Duplicate Address Detection (DAD) is enabled
\n

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This HTTP POST request is used to update the WAN settings for a specific WAN interface. The request should be sent with a JSON payload in the raw request body type.

Request Body

enabled: Indicates the status of the WAN interface.

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint makes an HTTP POST request to bind port configurations. The request should include a JSON payload in the raw request body type:

lan1:(yes|no) - Indicates bind LAN ETH1 to WAN X
\n
lan2:(yes|no) - Indicates bind LAN ETH2 to WAN X
\n
lan3:(yes|no) - Indicates bind LAN ETH3 to WAN X
\n
lan4:(yes|no) - Indicates bind LAN ETH4 to WAN X
\n
wifi24_ssid1:(yes|no) - Indicates bind WiFi 2.4GHz SSID1 to WAN X
\n
wifi24_ssid2:(yes|no) - Indicates bind WiFi 2.4GHz SSID2 to WAN X
\n
wifi24_ssid3:(yes|no) - Indicates bind WiFi 2.4GHz SSID3 to WAN X
\n
wifi24_ssid4:(yes|no) - Indicates bind WiFi 2.4GHz SSID4 to WAN X
\n
wifi5_ssid1:(yes|no) - Indicates bind WiFi 5GHz SSID1 to WAN X
\n
wifi5_ssid2:(yes|no) - Indicates bind WiFi 5GHz SSID2 to WAN X
\n
wifi5_ssid3:(yes|no) - Indicates bind WiFi 5GHz SSID3 to WAN X
\n
wifi5_ssid4:(yes|no) - Indicates bind WiFi 5GHz SSID4 to WAN X
\n

Response

Status: 200
message (string): A message indicating the result of the operation.

Apply Changes to WAN Configuration

This endpoint is used to apply changes of the specific WAN configuration.

Request Body

apply:(yes) - Indicates the action to apply changes to the WAN configuration.

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint is used to update the LAN settings.

Request Body

**enabled:(yes|no)**- Indicates whether the LAN is enabled.
\n
mode:(AUTO|100/FULL|100/HALF|10/FULL|10/HALF) - Specifies the mode for the LAN.
\n

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint makes an HTTP POST request to configure LAN settings. The request should include a JSON payload in the raw request body type

Request Body

dhcp_enable:(yes|no) - Indicates LAN DHCP server state.
\n
ip:(x.x.x.x) - The IP address for the LAN interface.
\n
netmask:(x.x.x.x) - The netmask for the LAN network.
\n
dhcp_lease_time:(300-259200) - The DHCP lease time for the LAN network.
\n
dhcp_start_ip:(x.x.x.x) - The start IP address for DHCP range.
\n
dhcp_end_ip:(x.x.x.x) - The end IP address for DHCP range.
\n
dns_proxy_type:(lan-ip|manual) - The DNS proxy type for the LAN configuration.
\n
dns_primary:(x.x.x.x) - The primary DNS address for the LAN configuration.
\n
dns_secondary:(x.x.x.x) - The secondary DNS address for the LAN configuration
\n

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint allows you to make an HTTP POST request in order to configure LAN DNS settings. The request should include a JSON payload in the raw request body type

Request Body

dns_proxy_type:(lan-ip|manual) - The DNS proxy type for the LAN configuration.
\n
dns_primary:(x.x.x.x) - The primary DNS address for the LAN configuration.
\n
dns_secondary:(x.x.x.x) - The secondary DNS address for the LAN configuration
\n

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint allows you to make an HTTP POST request in order to enable or disable DHCP server at LAN side. The request should include a payload with the raw request body type.

Request Body

enable:(yes|no) - Indicates LAN DHCP server state.

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint is used to apply changes to the LAN settings.

Request Body

apply:(yes) Set to yes to apply LAN settings.

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to make an HTTP POST request in order to configure settings for the 2.4GHz wireless LAN. The request should include a JSON payload.

Request Body

enable:(yes|no) - Indicates whether the 2.4GHz wireless LAN is enabled or not.
\n
mode: (802.11b/g/n|802.11n|802.11b/g|802.11g/n/ax) - Specifies the mode of operation for the wireless LAN.
\n
country:(full_country_name) - Specifies the country code for regulatory compliance.
\n
channel: (1-13) - Specifies the channel for the wireless LAN.
\n
channel_selection: (auto|manual) - Indicates the method for selecting the channel.
\n
channel_width:(40MHz|AUTO|20MHz) - Specifies the channel width for the wireless LAN.
\n
tx_power: (0-100) - Specifies the transmission power for the wireless LAN.
\n
min_rssi_sta_connect: -100-0) - Speficies the minimum RSSI value for device to connect to Wi-Fi
\n
min_rssi_sta_disconnect:(-100-0) - Speficies the minimum RSSI value for device to disconnect from Wi-Fi
\n

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This HTTP POST request is used to enable or disable the 2.4GHz WLAN. The request should include a JSON payload in the raw request body type.

Request Body

enable: (yes|no) - Set to yes to enable WLAN24, and no to disable it.

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint makes an HTTP POST request to create a new SSID for a 2.4GHz WLAN. The request should include a JSON payload in the raw request body type.

Request Body

state :(activated|deactivated) - Indicate the SSID X state
prefix:(0-10 characters) - The prefix for the SSID.
ssid_name:(0-32 characters) - The name of the SSID.
security:(wpapslwpa2psk|wpa2psk|open|wpa3psk|wpa2pslwpa3psk) - The security type for the SSID.
encryption:(aes|tkip|tkipaes) - The encryption type for the SSID.
password:(8-32 characters) - The password for the SSID.
hidden:(yes|no) - Indicates if SSID is hidden or not.
wps_enable:(yes|no) - Indicates if WPS is enabled for the SSID.

Response

status: 200
message (string): A message indicating the result of the operation.

This HTTP POST request is used to apply changes to the 2.4GHz WLAN settings. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply WLAN24 settings.

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to make an HTTP POST request in order to modify the settings for the 5GHz wireless LAN. The request should include a JSON payload.

Request Body

enable:(yes|no) - Indicates whether the 5GHz wireless LAN is enabled or not.
\n
mode: (802.11b/g/n|802.11n|802.11b/g|802.11g/n/ax) - Specifies the mode of operation for the wireless LAN.
\n
country:(full_country_name) - Specifies the country code for regulatory compliance.
\n
channel: (1-13) - Specifies the channel for the wireless LAN.
\n
channel_selection: (auto|manual) - Indicates the method for selecting the channel.
\n
channel_width:(40MHz|AUTO|20MHz) - Specifies the channel width for the wireless LAN.
\n
tx_power: (0-100) - Specifies the transmission power for the wireless LAN.
\n
dfs_enable: (yes|no) - Indicates whether the DFS is enabled or not.
\n
min_rssi_sta_connect: -100-0) - Speficies the minimum RSSI value for device to connect to Wi-Fi.
\n
min_rssi_sta_disconnect:(-100-0) - Speficies the minimum RSSI value for device to disconnect from Wi-Fi.
\n

This endpoint is used to enable or disable the WLAN5.

Request Body

enable: (yes|no) - Set to yes to enable WLAN5, and no to disable it.

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint makes an HTTP POST request to create a new SSID for a 5GHz WLAN. The request should include a JSON payload in the raw request body type.

Request Body

state :(activated|deactivated) - Indicate the SSID X state
\n
prefix:(0-10 characters) - The prefix for the SSID.
\n
ssid_name:(0-32 characters) - The name of the SSID.
\n
security:(wpapslwpa2psk|wpa2psk|open|wpa3psk|wpa2pslwpa3psk) - The security type for the SSID.
\n
encryption:(aes|tkip|tkipaes) - The encryption type for the SSID.
\n
password:(8-32 characters) - The password for the SSID.
\n
hidden:(yes|no) - Indicates if SSID is hidden or not.
\n
wps_enable:(yes|no) - Indicates if WPS is enabled for the SSID.
\n

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This HTTP POST request is used to apply changes to the 5GHz WLAN settings. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply WLAN5 settings.

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint allows you to configure EasyMesh ettings.

Request Body

enable:(yes|no) - Specify whether to enable EasyMesh.
device_role:(controller|agent) - Specify the role of the device in the WLAN mesh.
fast_roaming_enable:(yes|no) - Enable or disable fast roaming.
fast_roaming_type:(OTDS|OTA) - Specify the type of fast roaming.

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint makes an HTTP POST request to enable or disable EasyMesh feature. The request should include a JSON payload in the raw request body type.

Request Body

enable:(yes|no) - Specify whether to enable EasyMesh.

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint is used to apply changes to the WLAN mesh configuration.

Request Body

apply:(yes) - Set to apply EasyMesh settings.

Response

status: 200 OK
message (string): A message indicating the status of the operation.

This HTTP POST request is used to add a new VoIP configuration via the specified API endpoint. The request should include a JSON payload in the raw request body type.

Request Body

register_server:(x.x.x.x) - The server address of the SIP server.
\n
register_port:(1025-65536) - The port of SIP registration server.
\n

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint makes an HTTP POST request to add a VoIP line. The request should include a JSON payload in the raw request body type.

Request Body

enable:(yes|no) - Set to yes to enable VOIP account X, and no to disable it.
login:(0-32 characters) - VoIP account login
password:(0-32 characters) -password to the VoIP account
display_name:(0-32 characters) -string displayed as a caller ID

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint makes an HTTP POST request to add a VoIP line. The request should include a JSON payload in the raw request body type.

Request Body

warm_line_enable:(YES|NO) - Set to YES to enable the warm line feature, or NO to disable it.

warm_line_number:(0–20 characters) - Phone number automatically dialed when warm line is enabled.

warm_line_timeout:(0–20 characters) - Delay (in seconds) before the warm line number is dialed after going off-hook.

three_party_service_enable:(YES|NO) - Set to YES to enable three-party (conference) calling, or NO to disable it.

caller_id_mode:(FSK|DTMF) - Caller ID signaling method: FSK (Frequency Shift Keying) or DTMF (Dual-Tone Multi-Frequency).

min_flash_hook_time_interval:(0–10000) - Minimum acceptable flash hook signal duration in milliseconds.

max_flash_hook_time_interval:(0–10000) - Maximum acceptable flash hook signal duration in milliseconds.

min_flash_hook_time_release:(0–10000) - Minimum release time in milliseconds between flash hook presses.

call_waiting_enable:(ENABLE|DISABLE) - Set to ENABLE to activate call waiting, or DISABLE to turn it off.

silence_suppresion_enable:(NO|YES) - Set to YES to enable silence suppression (voice activity detection), or NO to disable it.

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint makes an HTTP POST request to create or update a VoIP line with the ID X. The request should include a JSON payload in the raw request body type.

Request Body

enable:(yes|no) - Set to yes to enable VOIP account X, and no to disable it.

Response

status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint makes an HTTP POST request to apply the VoIP settings.The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) -Set to yes to enable VOIP setings.

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to set or update rate limiting configurations.

Request Body

enable:(yes|no) - Set to yes to enable rate limiting, and no to disable it.

Response

status: 200 OK
message (string): A message indicating the success of the rate limiting configuration update.

This HTTP POST request is used to update the rate limit for a specific class of service (COS) at the specified endpoint. The request should include a JSON payload in the raw request body type.

Request Body

The request should include a raw JSON payload with the following parameters:

downstream:(GPON:0-2400, XGS-PON: 0-10000) - The downstream rate limit value for the specified CoS, in Mbit/s.
upstream:(GPON:0-1200, XGS-PON: 0-10000) - The upstream rate limit value for the specified CoS in Mbit/s.

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to apply rate limits by making an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply rate-limit settings.

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to send an HTTP POST request to in order to configure syslog settings.The request should include a JSON payload in the raw request body type.

Request Body

remote_enable:(yes|no) - Set to yes to enable rsyslog, and no to disable it.
remote_ip:(x.x.x.x) - host IP of log collector
remote_port:(1024-65536) - host port of log collector

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to send syslog configuration details via an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type.

Request Body

remote_enable:(yes|no) - Set to yes to enable rsyslog, and no to disable it.

Response

status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to apply syslog settings using an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply rsyslog settings.

Response

status: 200
message (string): A message indicating the result of the operation.

Add Documentation

This endpoint makes an HTTP POST request to update the passwords for admin and user. The request should include a JSON payload in the raw request body type.

Request Body

admin_password (string): The new password for the admin.
\n
user_password (string): The new password for the user.
\n
reset_user_password: (YES|NO) - Set to YES to reset useradmin password
\n

Response

Status: 200 OK
\n
message (string): A message confirming the success of the password update.
\n

This endpoint allows you to apply a password change. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply passwords settings.

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to update the time settings for the device. The request should include a JSON payload in the raw request body type.

Request Body

time_zone: (string): The time zone to be set for the device.
ntp_server1: (x.x.x.x): The address of the NTP server to be used for time synchronization.

Response

Status: 200
message (string): A message indicating the status of the time update process.

This HTTP POST request is used to apply management changes via the specified API endpoint. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply time settings.

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint makes an HTTP POST request to manage web settings. The request should include a JSON payload in the raw request body type.

wan_mgmt_enable: (yes|no)- enable or disable WAN management access ACL
\n
wan_port: (1025-65536) - www interface WAN http port
\n
wan_https_port:(1025-65536) - www interface WAN https port
\n
iphost_port:(1025-65536) - www interface iphost http port
\n
iphost_https_port:(1025-65536) - www interface iphost https port
\n
lan_web_access_enable:(yes|no) - access to the www from LAN side
\n
https_access_enable:(yes|no) - enable https
\n
web_language: (ENGLISH|POLSKI|DEUTSCH) - set language on web interface
\n

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This API endpoint makes an HTTP POST request to add an Access Control List (ACL) entry. The request should include a JSON payload in the raw request body type:

Request Body

ip_address:(x.x.x.x) - The IP address to be added to the ACL.
\n
net_mask:(y.y.y.y) - The net mask for the IP address.
\n

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint makes an HTTP POST request to manage web settings. The request should include a JSON payload in the raw request body type.

wan_mgmt_enable: (yes|no)- enable or disable WAN management access ACL
\n
wan_port: (1025-65536) - www interface WAN http port
\n
wan_https_port:(1025-65536) - www interface WAN https port
\n
lan_web_access_enable:(yes|no) - access to the www from LAN side
\n
https_access_enable:(yes|no) - enable https
\n

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint makes an HTTP POST request to apply management settings via the web interface. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply WEB settings.

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint makes an HTTP POST request to apply management settings via the web interface. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply WEB settings.

Response

Status: 200
message (string): A message indicating the result of the operation.

Add Documentation

This endpoint makes an HTTP POST request to configure igmp settings.

Request Body

igmp_snooping_enable: (YES|NO) - Set to YES to enable IGMP Snooping, or NO to disable
\n
igmp_lan_isolation\": (YES|NO) - Set to YES to enable LAN isolation for IGMP multicast traffic. Set to NO to allow multicast between LAN ports
\n

Response

Status: 200 OK
\n
message (string): A message confirming the success of the password update.
\n

This endpoint makes an HTTP POST request to apply multicast settings via the web interface. The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply WEB settings.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This HTTP POST request is used to add security configurations via the specified endpoint. The request should include a JSON payload in the raw request body type.

Request Body

lan_rogue_dhcp_filter: (yes|no) - enable or disable LAN rogue DHCP server filter

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint allows you to configure bridge filtering for security purposes. When making a POST request to this endpoint, you can provide a payload with various parameters to enable or disable specific types of filtering. The response will indicate the status of the request with a message.

The request should include a JSON payload in the raw request body type.

Request Body

enable: (yes|no) - Enable or disable the bridge filtering.
ipv6_upstream_block: (wan1-wan7) - enable function on specific WAN interface
ipv6_downstream_block:(wan1-wan7) - enable function on specific WAN interface
multicast_upstream_block:(wan1-wan7) - enable function on specific WAN interface
multicast_downstream_block:(wan1-wan7) - enable function on specific WAN interface.
flowcontrol_upstream_block:(wan1-wan7) - enable function on specific WAN interface
flowcontrol_downstream_block:(wan1-wan7) - enable function on specific WAN interface.
netbios_upstream_block:(wan1-wan7) - enable function on specific WAN interface
netbios_downstream_block:(wan1-wan7) - enable function on specific WAN interface
stp_upstream_block:(wan1-wan7) - enable function on specific WAN interface
stp_downstream_block:(wan1-wan7) - enable function on specific WAN interface
stormcontrol_block:(wan1-wan7) - enable function on specific WAN interface
stormcontrol_downstream_limit:(64,256,1024,4096) - Set the downstream limit for storm control.
stormcontrol_multicast (yes|no) - enable or disable multicast forwarding on LAN side
stormcontrol_broadcast``(yes|no) - enable or disable storm control
stormcontrol_force_lan: (yes|no) - enable or disable storm control on LAN side

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint makes an HTTP POST request to the specified URL in order to modify the bridge filter security settings. The request should include a JSON payload in the raw request body type.

Request Body

enable:(yes|no) - Set to yes to enable Bridge Filter, and no to disable it.

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint is used to apply bridge filter settings.

Request Body

apply:(yes|no) - Set to yes to apply Bridge Filter.

Response

Status: 200
message (string): A message indicating the result of the operation.

This HTTP POST request is used to apply security settings by sending a payload to the specified endpoint.The request should include a JSON payload in the raw request body type.

Request Body

apply:(yes) - Set to yes to apply Security.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint allows you to make an HTTP POST request to the specified URL in order to configure the NAT settings. The request should include a JSON payload.

Request Body

tcp_timeout_established: (1|12|24|120) - Time (in hours) before an established TCP connection is closed

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint allows you to make an HTTP POST request to the specified URL in order to configure the DMZ (Demilitarized Zone) settings. The request should include a JSON payload.

Request Body

enabled: (yes|no) - Indicates whether the DMZ is enabled or disabled.
interface:(wan1-wan7) - Specifies the interface(with NAT enabled) for the DMZ configuration.
host_ip:(x.x.x.x) - Represents the IP address of the host for the DMZ.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This HTTP POST request is used to enable DMZ (Demilitarized Zone) configuration in the NAT (Network Address Translation) settings.

Request Body

enable:(yes|no) - Set to yes to enable DMZ, and no to disable it.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint is used to configure the DMZ (Demilitarized Zone) settings.

Request Body

apply:(yes) - Set yes to apply DMZ configuration

Response

Status: 200
message (string): A message indicating the result of the operation.

This endpoint makes an HTTP POST request to configure NAT ALG settings. The request body should be in raw format with the following parameters: ftp, sip, l2tp, ipsec, and pptp. Each parameter should be set to either YES or NO to enable or disable the corresponding ALG.

Request Body

ftp:(yes|no) - enable or disable FTP AGL support\nsip:(yes|no) - enable or disable SIP AGL support\nl2tp:(yes|no) - enable or disable L2TP AGL support\nipsec:(yes|no) - enable or disable IPSEC AGL support\npptp:(yes|no) - enable or disable PPTP AGL support

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

Request Body

apply:(yes) - Set to yes to enable ALG config

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint makes an HTTP POST request to create a port forwarding rule for NAT configuration.

Request Body

active:(yes|no) - Indicates whether the port forwarding rule is active or not.
protocol:`(udp|tcp|(tcp|udp)) - Specifies the protocol to be used for the port forwarding rule.
wan_start_port:(1025-65536) - The starting port on the WAN side for the port forwarding rule.
wan_end_port:(1025-65536) - The ending port on the WAN side for the port forwarding rule.
local_ip:(x.x.x.x) - The local IP address to which the traffic will be forwarded.
lan_start_port:(1025-65536) - The starting port on the LAN side for the port forwarding rule.
name:(custom_name) - A name or label for the port forwarding rule.
nat_loopback_enabled:`(yes|no) - Indicates whether NAT loopback is enabled for the port forwarding rule.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint is used to apply port forwarding rules for network address translation (NAT) configuration.

Request Body

apply:(yes) - Set to yes to apply NAT port forwarding rules.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

Request Body

apply:(yes) - Set to yes to enable ALG config

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This endpoint is used to configure static routes on the device.

Request Body

enable :(yes|no) - Indicates whether this static route is enabled.
\n
dst_ip: (x.x.x.x) - Destination network IP address
\n
netmask:(y.y.y.y) - Subnet mask for the destination network
\n
nat_to_route: (yes|no) - Enable NAT on this rule
\n
gateway: (z.z.z.z) - Gateway IP address
\n
interface: (WAN1|WAN2|WAN3|WAN4|WAN5|WAN6) - WAN interface used for this rule
\n
metric: (0-15) - Metric value of this route
\n

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

Request Body

apply:(yes) - Set to yes to apply IPv4 Static route

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

Provisioning API

This API endpoint makes an HTTP POST request to the specified URL for provisioning tool.

Request Body

url:(halny_provisioning_url) - The URL for provisioning.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This HTTP POST request is used to upgrade the mesh agent with the specified parameters. The request should include a JSON payload with the following keys: model_name, firmware_version, server_type, server_address, server_login, server_password, file_name, and reboot_time.

Request Body

model_name:(text) -The model name of the device to be upgraded.
firmware_version:(text) - The version of the firmware to be upgraded.
server_type:(text) - The type of server for the upgrade.
server_address:(text) - The address of the server for the upgrade.
server_login:(text) - The login credentials for the server.
server_password:(text) - The password for the server login.
file_name:(text) - The name of the file for the upgrade.
reboot_time:(text) - The time for reboot after the upgrade.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

This HTTP POST request is used to upgrade the mesh agent.

Request

The request body should be in raw format and should include the following parameter:

enable:(yes|no) - Indicates whether the EasyMesh Agent upgrade is enabled or not.

Response

Status: 200
message (string): A message indicating the result of the operation.

Request Body

apply:(yes) - Set to yes to apply EasyMesh Agent upgrade settings.

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

Update Mesh Network Topology

This POST request is used to update the mesh network topology.

Request Body

update:(yes) - refresh EasyMesh network topology

Response

message: A message indicating the status of the update operation.

This HTTP POST request is used to set RF port state.

Request Body

enabled:(yes|no) - Set RF port status

Response

Status: 200
\n
message (string): A message indicating the result of the operation.
\n

The following are the currently supported POST methods, with each value being of type string.

\n","_postman_id":"1f91ac2c-0a19-45c4-b8ab-3ec9e7484d82","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_pass}}"}]},"isInherited":true,"source":{"_postman_id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","id":"17da0852-ae2e-4ae0-be93-36fb7d136dc5","name":"HALNy REST API V2","type":"collection"}}},{"name":"DELETE","item":[{"name":"WAN_X","id":"0953c469-f217-49d4-9ca2-b2efd0995acc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://{{ont_ip}}:48626/api/v2/wan/1","description":"

This HTTP DELETE request is used to delete a specific resource at the given endpoint.