How Can We Help?

REST API

You are here:
< All Topics
Document Date and version2023.04.20
Tested on OLTrequired OLT with IP-host support
Tested with ONT HALNy HL-4GMVSupported on version V2.0.24p1/V3.1.24p1 or above
Revision1
Let us know how to improve below document on: support@halny.com

How to run

  • configure IP-host interface for ONT and check IP-HOST-ADDRESS
  • send an HTTP request to API interface on port 48625
  • select proper URL to read (you can check available parameters by sending http://IP-HOST-ADDRESS:48625/api/v1/help)

http://IP-HOST-ADDRESS:48625/api/v1/URL

http://10.10.10.2:48625/api/v1/help

All nodes listing

All possible URL (data to read) are listed below. (output of http://IP-HOST-ADDRESS:48625/api/v1/help)

RESTAPI VERSION (GET):
/api/v1/restapi_version -> restapi_version

STATUS (GET):
/api/v1/status/olt_id -> olt_id
/api/v1/status/ont_id -> ont_id
/api/v1/status/service_mode -> service_mode
/api/v1/status/optic_rx_power -> optic_rx_power
/api/v1/status/optic_tx_power -> optic_tx_power
/api/v1/status/model_name -> ont_model_name
/api/v1/status/serial_nr -> ont_gpon_serial_nr
/api/v1/status/hex_serial_nr -> ont_gpon_hex_serial_nr
/api/v1/status/hw_version -> ont_hw_version
/api/v1/status/mac -> ont_mac
/api/v1/status/active_firmware_ver -> active_firmware_ver
/api/v1/status/standby_firmware_ver -> standby_firmware_ver
/api/v1/status/uptime -> system_uptime
/api/v1/status/all

SOFTWARE (GET):
/api/v1/software/active_firmware_ver -> active_firmware_ver
/api/v1/software/standby_firmware_ver -> standby_firmware_ver
/api/v1/software/os1_firmware_ver -> os1_firmware_ver
/api/v1/software/os1_running_os -> os1_running_os
/api/v1/software/os1_default_os -> os1_default_os
/api/v1/software/os2_firmware_ver -> os2_firmware_ver
/api/v1/software/os2_running_os -> os2_running_os
/api/v1/software/os2_default_os -> os2_default_os
/api/v1/software/all

LAN (GET):
/api/v1/lan/ip -> lan_ip
/api/v1/lan/netmask -> lan_netmask
/api/v1/lan/dhcp_enable -> lan_dhcp_enable
/api/v1/lan/dhcp_start_ip -> lan_dhcp_start_ip
/api/v1/lan/dhcp_end_ip -> lan_dhcp_end_ip
/api/v1/lan/dhcp_lease_time -> lan_dhcp_lease_time
/api/v1/lan/dns_proxy_enable -> lan_dns_proxy_enable
/api/v1/lan/dns_proxy_type -> lan_dns_proxy_type
/api/v1/lan/dns_primary -> lan_dns_primary
/api/v1/lan/dns_secondary -> lan_dns_secondary
/api/v1/lan/1/status -> lan1_status
/api/v1/lan/1/mode -> lan1_mode
/api/v1/lan/2/status -> lan2_status
/api/v1/lan/2/mode -> lan2_mode
/api/v1/lan/3/status -> lan3_status
/api/v1/lan/3/mode -> lan3_mode
/api/v1/lan/4/status -> lan4_status
/api/v1/lan/4/mode -> lan4_mode
/api/v1/lan/all

CONNECTED DEVICES MAC (GET):
/api/v1/connected_dev_mac/lan/1 -> connected_dev_mac_lan1
/api/v1/connected_dev_mac/lan/2 -> connected_dev_mac_lan2
/api/v1/connected_dev_mac/lan/3 -> connected_dev_mac_lan3
/api/v1/connected_dev_mac/lan/4 -> connected_dev_mac_lan4
/api/v1/connected_dev_mac/wlan/2.4/1 -> connected_dev_mac_wlan24_1
/api/v1/connected_dev_mac/wlan/2.4/2 -> connected_dev_mac_wlan24_2
/api/v1/connected_dev_mac/wlan/2.4/3 -> connected_dev_mac_wlan24_3
/api/v1/connected_dev_mac/wlan/2.4/4 -> connected_dev_mac_wlan24_4
/api/v1/connected_dev_mac/wlan/5/1 -> connected_dev_mac_wlan5_1
/api/v1/connected_dev_mac/wlan/5/2 -> connected_dev_mac_wlan5_2
/api/v1/connected_dev_mac/wlan/5/3 -> connected_dev_mac_wlan5_3
/api/v1/connected_dev_mac/wlan/5/4 -> connected_dev_mac_wlan5_4
/api/v1/connected_dev_mac/all

WIRELESS LAN 2.4GHz (GET):
/api/v1/wlan/2.4/country -> wlan24_country
/api/v1/wlan/2.4/channel -> wlan24_channel
/api/v1/wlan/2.4/tx_power -> wlan24_tx_power
/api/v1/wlan/2.4/ssid/1/enable -> wlan24_ssid1_enable
/api/v1/wlan/2.4/ssid/1/prefix -> wlan24_ssid1_prefix
/api/v1/wlan/2.4/ssid/1/ssid_name -> wlan24_ssid1_ssid_name
/api/v1/wlan/2.4/ssid/1/password -> wlan24_ssid1_password
/api/v1/wlan/2.4/ssid/1/security -> wlan24_ssid1_security
/api/v1/wlan/2.4/ssid/1/encryption -> wlan24_ssid1_encryption
/api/v1/wlan/2.4/ssid/2/enable -> wlan24_ssid2_enable
/api/v1/wlan/2.4/ssid/2/prefix -> wlan24_ssid2_prefix
/api/v1/wlan/2.4/ssid/2/ssid_name -> wlan24_ssid2_ssid_name
/api/v1/wlan/2.4/ssid/2/password -> wlan24_ssid2_password
/api/v1/wlan/2.4/ssid/2/security -> wlan24_ssid2_security
/api/v1/wlan/2.4/ssid/2/encryption -> wlan24_ssid2_encryption
/api/v1/wlan/2.4/ssid/3/enable -> wlan24_ssid3_enable
/api/v1/wlan/2.4/ssid/3/prefix -> wlan24_ssid3_prefix
/api/v1/wlan/2.4/ssid/3/ssid_name -> wlan24_ssid3_ssid_name
/api/v1/wlan/2.4/ssid/3/password -> wlan24_ssid3_password
/api/v1/wlan/2.4/ssid/3/security -> wlan24_ssid3_security
/api/v1/wlan/2.4/ssid/3/encryption -> wlan24_ssid3_encryption
/api/v1/wlan/2.4/ssid/4/enable -> wlan24_ssid4_enable
/api/v1/wlan/2.4/ssid/4/prefix -> wlan24_ssid4_prefix
/api/v1/wlan/2.4/ssid/4/ssid_name -> wlan24_ssid4_ssid_name
/api/v1/wlan/2.4/ssid/4/password -> wlan24_ssid4_password
/api/v1/wlan/2.4/ssid/4/security -> wlan24_ssid4_security
/api/v1/wlan/2.4/ssid/4/encryption -> wlan24_ssid4_encryption

WIRELESS LAN 5GHz (GET):
/api/v1/wlan/5/country -> wlan5_country
/api/v1/wlan/5/channel -> wlan5_channel
/api/v1/wlan/5/tx_power -> wlan5_tx_power
/api/v1/wlan/5/ssid/1/enable -> wlan5_ssid1_enable
/api/v1/wlan/5/ssid/1/prefix -> wlan5_ssid1_prefix
/api/v1/wlan/5/ssid/1/ssid_name -> wlan5_ssid1_ssid_name
/api/v1/wlan/5/ssid/1/password -> wlan5_ssid1_password
/api/v1/wlan/5/ssid/1/security -> wlan5_ssid1_security
/api/v1/wlan/5/ssid/1/encryption -> wlan5_ssid1_encryption
/api/v1/wlan/5/ssid/2/enable -> wlan5_ssid2_enable
/api/v1/wlan/5/ssid/2/prefix -> wlan5_ssid2_prefix
/api/v1/wlan/5/ssid/2/ssid_name -> wlan5_ssid2_ssid_name
/api/v1/wlan/5/ssid/2/password -> wlan5_ssid2_password
/api/v1/wlan/5/ssid/2/security -> wlan5_ssid2_security
/api/v1/wlan/5/ssid/2/encryption -> wlan5_ssid2_encryption
/api/v1/wlan/5/ssid/3/enable -> wlan5_ssid3_enable
/api/v1/wlan/5/ssid/3/prefix -> wlan5_ssid3_prefix
/api/v1/wlan/5/ssid/3/ssid_name -> wlan5_ssid3_ssid_name
/api/v1/wlan/5/ssid/3/password -> wlan5_ssid3_password
/api/v1/wlan/5/ssid/3/security -> wlan5_ssid3_security
/api/v1/wlan/5/ssid/3/encryption -> wlan5_ssid3_encryption
/api/v1/wlan/5/ssid/4/enable -> wlan5_ssid4_enable
/api/v1/wlan/5/ssid/4/prefix -> wlan5_ssid4_prefix
/api/v1/wlan/5/ssid/4/ssid_name -> wlan5_ssid4_ssid_name
/api/v1/wlan/5/ssid/4/password -> wlan5_ssid4_password
/api/v1/wlan/5/ssid/4/security -> wlan5_ssid4_security
/api/v1/wlan/5/ssid/4/encryption -> wlan5_ssid4_encryption

WIRELESS LAN ALL (GET):
/api/v1/wlan/all

WAN INTERFACE (GET):
/api/v1/wan/1/status -> wan1_status
/api/v1/wan/1/mac -> wan1_mac
/api/v1/wan/1/conn_type -> wan1_conn_type
/api/v1/wan/1/ip -> wan1_ip
/api/v1/wan/1/netmask -> wan1_netmask
/api/v1/wan/1/gateway -> wan1_gateway
/api/v1/wan/1/dns/1 -> wan1_dns1
/api/v1/wan/1/dns/2 -> wan1_dns2
/api/v1/wan/1/ppp_status -> wan1_ppp_status
/api/v1/wan/1/ppp_login -> wan1_ppp_login
/api/v1/wan/1/ppp_password -> wan1_ppp_password
/api/v1/wan/1/all
/api/v1/wan/2/status -> wan2_status
/api/v1/wan/2/mac -> wan2_mac
/api/v1/wan/2/conn_type -> wan2_conn_type
/api/v1/wan/2/ip -> wan2_ip
/api/v1/wan/2/netmask -> wan2_netmask
/api/v1/wan/2/gateway -> wan2_gateway
/api/v1/wan/2/dns/1 -> wan2_dns1
/api/v1/wan/2/dns/2 -> wan2_dns2
/api/v1/wan/2/ppp_status -> wan2_ppp_status
/api/v1/wan/2/ppp_login -> wan2_ppp_login
/api/v1/wan/2/ppp_password -> wan2_ppp_password
/api/v1/wan/2/all
/api/v1/wan/3/status -> wan3_status
/api/v1/wan/3/mac -> wan3_mac
/api/v1/wan/3/conn_type -> wan3_conn_type
/api/v1/wan/3/ip -> wan3_ip
/api/v1/wan/3/netmask -> wan3_netmask
/api/v1/wan/3/gateway -> wan3_gateway
/api/v1/wan/3/dns/1 -> wan3_dns1
/api/v1/wan/3/dns/2 -> wan3_dns2
/api/v1/wan/3/ppp_status -> wan3_ppp_status
/api/v1/wan/3/ppp_login -> wan3_ppp_login
/api/v1/wan/3/ppp_password -> wan3_ppp_password
/api/v1/wan/3/all
/api/v1/wan/4/status -> wan4_status
/api/v1/wan/4/mac -> wan4_mac
/api/v1/wan/4/conn_type -> wan4_conn_type
/api/v1/wan/4/ip -> wan4_ip
/api/v1/wan/4/netmask -> wan4_netmask
/api/v1/wan/4/gateway -> wan4_gateway
/api/v1/wan/4/dns/1 -> wan4_dns1
/api/v1/wan/4/dns/2 -> wan4_dns2
/api/v1/wan/4/ppp_status -> wan4_ppp_status
/api/v1/wan/4/ppp_login -> wan4_ppp_login
/api/v1/wan/4/ppp_password -> wan4_ppp_password
/api/v1/wan/4/all
/api/v1/wan/5/status -> wan5_status
/api/v1/wan/5/mac -> wan5_mac
/api/v1/wan/5/conn_type -> wan5_conn_type
/api/v1/wan/5/ip -> wan5_ip
/api/v1/wan/5/netmask -> wan5_netmask
/api/v1/wan/5/gateway -> wan5_gateway
/api/v1/wan/5/dns/1 -> wan5_dns1
/api/v1/wan/5/dns/2 -> wan5_dns2
/api/v1/wan/5/ppp_status -> wan5_ppp_status
/api/v1/wan/5/ppp_login -> wan5_ppp_login
/api/v1/wan/5/ppp_password -> wan5_ppp_password
/api/v1/wan/5/all
/api/v1/wan/6/status -> wan6_status
/api/v1/wan/6/mac -> wan6_mac
/api/v1/wan/6/conn_type -> wan6_conn_type
/api/v1/wan/6/ip -> wan6_ip
/api/v1/wan/6/netmask -> wan6_netmask
/api/v1/wan/6/gateway -> wan6_gateway
/api/v1/wan/6/dns/1 -> wan6_dns1
/api/v1/wan/6/dns/2 -> wan6_dns2
/api/v1/wan/6/ppp_status -> wan6_ppp_status
/api/v1/wan/6/ppp_login -> wan6_ppp_login
/api/v1/wan/6/ppp_password -> wan6_ppp_password
/api/v1/wan/6/all
/api/v1/wan/7/status -> wan7_status
/api/v1/wan/7/mac -> wan7_mac
/api/v1/wan/7/conn_type -> wan7_conn_type
/api/v1/wan/7/ip -> wan7_ip
/api/v1/wan/7/netmask -> wan7_netmask
/api/v1/wan/7/gateway -> wan7_gateway
/api/v1/wan/7/dns/1 -> wan7_dns1
/api/v1/wan/7/dns/2 -> wan7_dns2
/api/v1/wan/7/ppp_status -> wan7_ppp_status
/api/v1/wan/7/ppp_login -> wan7_ppp_login
/api/v1/wan/7/ppp_password -> wan7_ppp_password
/api/v1/wan/7/all
/api/v1/wan/active_number -> active_wan_number
/api/v1/wan/all

INTERFACE STATISTICS (GET):
/api/v1/counter/lan_wlan_sum_rx -> lan_wlan_sum_rx
/api/v1/counter/lan_wlan_sum_tx -> lan_wlan_sum_tx
/api/v1/counter/lan/1/rx -> lan1_rx
/api/v1/counter/lan/1/tx -> lan1_tx
/api/v1/counter/lan/2/rx -> lan2_rx
/api/v1/counter/lan/2/tx -> lan2_tx
/api/v1/counter/lan/3/rx -> lan3_rx
/api/v1/counter/lan/3/tx -> lan3_tx
/api/v1/counter/lan/4/rx -> lan4_rx
/api/v1/counter/lan/4/tx -> lan4_tx
/api/v1/counter/lan/all
/api/v1/counter/wlan/2.4/1/rx -> wlan24_1_rx
/api/v1/counter/wlan/2.4/1/tx -> wlan24_1_tx
/api/v1/counter/wlan/2.4/2/rx -> wlan24_2_rx
/api/v1/counter/wlan/2.4/2/tx -> wlan24_2_tx
/api/v1/counter/wlan/2.4/3/rx -> wlan24_3_rx
/api/v1/counter/wlan/2.4/3/tx -> wlan24_3_tx
/api/v1/counter/wlan/2.4/4/rx -> wlan24_4_rx
/api/v1/counter/wlan/2.4/4/tx -> wlan24_4_tx
/api/v1/counter/wlan/2.4/all
/api/v1/counter/wlan/5/1/rx -> wlan5_1_rx
/api/v1/counter/wlan/5/1/tx -> wlan5_1_tx
/api/v1/counter/wlan/5/2/rx -> wlan5_2_rx
/api/v1/counter/wlan/5/2/tx -> wlan5_2_tx
/api/v1/counter/wlan/5/3/rx -> wlan5_3_rx
/api/v1/counter/wlan/5/3/tx -> wlan5_3_tx
/api/v1/counter/wlan/5/4/rx -> wlan5_4_rx
/api/v1/counter/wlan/5/4/tx -> wlan5_4_tx
/api/v1/counter/wlan/5/all
/api/v1/counter/all

OPTIC (GET):
/api/v1/optic/mode -> mode
/api/v1/optic/link_status -> link_status
/api/v1/optic/rx_power -> rx_power
/api/v1/optic/tx_power -> tx_power
/api/v1/optic/supply_voltage -> supply_voltage
/api/v1/optic/tx_bias_current -> tx_bias_current
/api/v1/optic/temperature -> temperature
/api/v1/optic/all

VOIP (GET):
/api/v1/voip/bind_interface -> bind_interface
/api/v1/voip/register_server -> register_server
/api/v1/voip/register_port -> register_port
/api/v1/voip/registration_expire -> registration_expire
/api/v1/voip/region -> region
/api/v1/voip/dtmf -> dtmf
/api/v1/voip/digit_map -> digit_map
/api/v1/voip/1/line_status -> voip1_line_status
/api/v1/voip/1/register_status -> voip1_register_status
/api/v1/voip/1/login -> voip1_login
/api/v1/voip/1/password -> voip1_password
/api/v1/voip/1/codec -> voip1_codec
/api/v1/voip/1/all
/api/v1/voip/all

SYSTEM (GET):
/api/v1/system/uptime -> uptime
/api/v1/system/memory_usage -> memory_usage
/api/v1/system/load_average -> load_average
/api/v1/system/all

RATE-LIMIT (GET):
/api/v1/rate_limit/enable -> enable
/api/v1/rate_limit/type -> type
/api/v1/rate_limit/setby -> setby
/api/v1/rate_limit/cos/0/downstream -> cos0_downstream
/api/v1/rate_limit/cos/0/upstream -> cos0_upstream
/api/v1/rate_limit/cos/1/downstream -> cos1_downstream
/api/v1/rate_limit/cos/1/upstream -> cos1_upstream
/api/v1/rate_limit/cos/2/downstream -> cos2_downstream
/api/v1/rate_limit/cos/2/upstream -> cos2_upstream
/api/v1/rate_limit/cos/3/downstream -> cos3_downstream
/api/v1/rate_limit/cos/3/upstream -> cos3_upstream
/api/v1/rate_limit/cos/4/downstream -> cos4_downstream
/api/v1/rate_limit/cos/4/upstream -> cos4_upstream
/api/v1/rate_limit/cos/5/downstream -> cos5_downstream
/api/v1/rate_limit/cos/5/upstream -> cos5_upstream
/api/v1/rate_limit/cos/6/downstream -> cos6_downstream
/api/v1/rate_limit/cos/6/upstream -> cos6_upstream
/api/v1/rate_limit/cos/7/downstream -> cos7_downstream
/api/v1/rate_limit/cos/7/upstream -> cos7_upstream
/api/v1/rate_limit/cos/all
/api/v1/rate_limit/all

SYSLOG (GET):
/api/v1/syslog/remote_enable -> remote_enable
/api/v1/syslog/remote_ip -> remote_ip
/api/v1/syslog/remote_port -> remote_port
/api/v1/syslog/all

MANAGEMENT (GET):
/api/v1/managment/admin_password -> admin_password
/api/v1/managment/user_password -> user_password
/api/v1/managment/time_zone -> time_zone
/api/v1/managment/ntp_server1 -> ntp_server1
/api/v1/managment/ntp_server2 -> ntp_server2
/api/v1/management/web/lan_access -> web_lan_access
/api/v1/management/web/iphost_port -> web_iphost_port
/api/v1/management/web/enable -> web_enable
/api/v1/management/web/wan_if -> web_wan_if
/api/v1/management/web/port -> web_port
/api/v1/management/web/acl_enable -> web_acl_enable
/api/v1/management/web/acl/ip_address1 -> web_acl_ip_address1
/api/v1/management/web/acl/netmask1 -> web_acl_netmask1
/api/v1/management/web/acl/ip_address2 -> web_acl_ip_address2
/api/v1/management/web/acl/netmask2 -> web_acl_netmask2
/api/v1/management/web/acl/ip_address3 -> web_acl_ip_address3
/api/v1/management/web/acl/netmask3 -> web_acl_netmask3
/api/v1/management/web/acl/ip_address4 -> web_acl_ip_address4
/api/v1/management/web/acl/netmask4 -> web_acl_netmask4
/api/v1/management/web/acl/ip_address5 -> web_acl_ip_address5
/api/v1/management/web/acl/netmask5 -> web_acl_netmask5
/api/v1/management/web/acl/ip_address6 -> web_acl_ip_address6
/api/v1/management/web/acl/netmask6 -> web_acl_netmask6
/api/v1/management/web/acl/ip_address7 -> web_acl_ip_address7
/api/v1/management/web/acl/netmask7 -> web_acl_netmask7
/api/v1/management/web/acl/ip_address8 -> web_acl_ip_address8
/api/v1/management/web/acl/netmask8 -> web_acl_netmask8
/api/v1/management/web/acl/ip_address9 -> web_acl_ip_address9
/api/v1/management/web/acl/netmask9 -> web_acl_netmask9
/api/v1/management/web/acl/ip_address10 -> web_acl_ip_address10
/api/v1/management/web/acl/netmask10 -> web_acl_netmask10
/api/v1/management/all

SECUIRITY (GET):
/api/v1/security/lan_rogue_dhcp_filter -> lan_rogue_dhcp_filter
/api/v1/security/filter/bridge/enable -> filter_bridge_enable
/api/v1/security/filter/bridge/ipv6_upstream_block -> filter_bridge_ipv6_upstream_block
/api/v1/security/filter/bridge/ipv6_downstream_block -> filter_bridge_ipv6_downstream_block
/api/v1/security/filter/bridge/multicast_upstream_block -> filter_bridge_multicast_upstream_block
/api/v1/security/filter/bridge/multicast_downstream_block -> filter_bridge_multicast_downstream_block
/api/v1/security/filter/bridge/flowcontrol_upstream_block -> filter_bridge_flowcontrol_upstream_block
/api/v1/security/filter/bridge/flowcontrol_downstream_block -> filter_bridge_flowcontrol_downstream_block
/api/v1/security/filter/bridge/netbios_upstream_block -> filter_bridge_netbios_upstream_block
/api/v1/security/filter/bridge/netbios_downstream_block -> filter_bridge_netbios_downstream_block
/api/v1/security/filter/bridge/stormcontrol_upstream_block -> filter_bridge_stormcontrol_upstream_block
/api/v1/security/filter/bridge/stormcontrol_downstream_block -> filter_bridge_stormcontrol_downstream_block
/api/v1/security/filter/bridge/stp_upstream_block -> filter_bridge_stp_upstream_block
/api/v1/security/filter/bridge/stp_downstream_block -> filter_bridge_stp_downstream_block
/api/v1/security/filter/bridge/stormcontrol_upstream_limit -> filter_bridge_stormcontrol_upstream_limit
/api/v1/security/filter/bridge/stormcontrol_downstream_limit -> filter_bridge_stormcontrol_downstream_limit
/api/v1/security/filter/bridge/stormcontrol_multicast -> filter_bridge_stormcontrol_multicast
/api/v1/security/filter/bridge/stormcontrol_broadcast -> filter_bridge_stormcontrol_broadcast
/api/v1/security/all

MULTICAST (GET):
/api/v1/multicast/igmp_snooping_enable -> igmp_snooping_enable
/api/v1/multicast/igmp_lan_isolation -> igmp_lan_isolation
/api/v1/multicast/igmp_proxy_enable -> igmp_proxy_enable
/api/v1/multicast/igmp_proxy_upstream_nas -> igmp_proxy_upstream_nas
/api/v1/multicast/groups/igmp_mcast_lan_port -> groups_igmp_mcast_lan_port
/api/v1/multicast/groups/igmp_mcast_ip -> groups_igmp_mcast_ip
/api/v1/multicast/groups/igmp_mcast_reporter_mac -> groups_igmp_mcast_reporter_mac
/api/v1/multicast/groups/igmp_mcast_vlan -> groups_igmp_mcast_vlan
/api/v1/multicast/groups/igmp_mcast_in_use -> groups_igmp_mcast_in_use
/api/v1/multicast/groups/all
/api/v1/multicast/all

NAT CONFIGURATION (GET):
/api/v1/nat_config/dmz_active -> dmz_active
/api/v1/nat_config/dmz_interface -> dmz_interface
/api/v1/nat_config/dmz_ip -> dmz_ip
/api/v1/nat_config/alg_ftp -> alg_ftp
/api/v1/nat_config/alg_sip -> alg_sip
/api/v1/nat_config/alg_l2tp -> alg_l2tp
/api/v1/nat_config/alg_ipsec -> alg_ipsec
/api/v1/nat_config/alg_pptp -> alg_pptp
/api/v1/nat_config/port_forwarding_rule/0/wan_start_port -> port_forwarding_rule0_wan_start_port
/api/v1/nat_config/port_forwarding_rule/0/wan_end_port -> port_forwarding_rule0_wan_end_port
/api/v1/nat_config/port_forwarding_rule/0/local_ip -> port_forwarding_rule0_local_ip
/api/v1/nat_config/port_forwarding_rule/0/lan_start_port -> port_forwarding_rule0_lan_start_port
/api/v1/nat_config/port_forwarding_rule/0/lan_end_port -> port_forwarding_rule0_lan_end_port
/api/v1/nat_config/port_forwarding_rule/1/wan_start_port -> port_forwarding_rule1_wan_start_port
/api/v1/nat_config/port_forwarding_rule/1/wan_end_port -> port_forwarding_rule1_wan_end_port
/api/v1/nat_config/port_forwarding_rule/1/local_ip -> port_forwarding_rule1_local_ip
/api/v1/nat_config/port_forwarding_rule/1/lan_start_port -> port_forwarding_rule1_lan_start_port
/api/v1/nat_config/port_forwarding_rule/1/lan_end_port -> port_forwarding_rule1_lan_end_port
/api/v1/nat_config/port_forwarding_rule/2/wan_start_port -> port_forwarding_rule2_wan_start_port
/api/v1/nat_config/port_forwarding_rule/2/wan_end_port -> port_forwarding_rule2_wan_end_port
/api/v1/nat_config/port_forwarding_rule/2/local_ip -> port_forwarding_rule2_local_ip
/api/v1/nat_config/port_forwarding_rule/2/lan_start_port -> port_forwarding_rule2_lan_start_port
/api/v1/nat_config/port_forwarding_rule/2/lan_end_port -> port_forwarding_rule2_lan_end_port
/api/v1/nat_config/port_forwarding_rule/3/wan_start_port -> port_forwarding_rule3_wan_start_port
/api/v1/nat_config/port_forwarding_rule/3/wan_end_port -> port_forwarding_rule3_wan_end_port
/api/v1/nat_config/port_forwarding_rule/3/local_ip -> port_forwarding_rule3_local_ip
/api/v1/nat_config/port_forwarding_rule/3/lan_start_port -> port_forwarding_rule3_lan_start_port
/api/v1/nat_config/port_forwarding_rule/3/lan_end_port -> port_forwarding_rule3_lan_end_port
/api/v1/nat_config/port_forwarding_rule/4/wan_start_port -> port_forwarding_rule4_wan_start_port
/api/v1/nat_config/port_forwarding_rule/4/wan_end_port -> port_forwarding_rule4_wan_end_port
/api/v1/nat_config/port_forwarding_rule/4/local_ip -> port_forwarding_rule4_local_ip
/api/v1/nat_config/port_forwarding_rule/4/lan_start_port -> port_forwarding_rule4_lan_start_port
/api/v1/nat_config/port_forwarding_rule/4/lan_end_port -> port_forwarding_rule4_lan_end_port
/api/v1/nat_config/port_forwarding_rule/5/wan_start_port -> port_forwarding_rule5_wan_start_port
/api/v1/nat_config/port_forwarding_rule/5/wan_end_port -> port_forwarding_rule5_wan_end_port
/api/v1/nat_config/port_forwarding_rule/5/local_ip -> port_forwarding_rule5_local_ip
/api/v1/nat_config/port_forwarding_rule/5/lan_start_port -> port_forwarding_rule5_lan_start_port
/api/v1/nat_config/port_forwarding_rule/5/lan_end_port -> port_forwarding_rule5_lan_end_port
/api/v1/nat_config/port_forwarding_rule/6/wan_start_port -> port_forwarding_rule6_wan_start_port
/api/v1/nat_config/port_forwarding_rule/6/wan_end_port -> port_forwarding_rule6_wan_end_port
/api/v1/nat_config/port_forwarding_rule/6/local_ip -> port_forwarding_rule6_local_ip
/api/v1/nat_config/port_forwarding_rule/6/lan_start_port -> port_forwarding_rule6_lan_start_port
/api/v1/nat_config/port_forwarding_rule/6/lan_end_port -> port_forwarding_rule6_lan_end_port
/api/v1/nat_config/port_forwarding_rule/7/wan_start_port -> port_forwarding_rule7_wan_start_port
/api/v1/nat_config/port_forwarding_rule/7/wan_end_port -> port_forwarding_rule7_wan_end_port
/api/v1/nat_config/port_forwarding_rule/7/local_ip -> port_forwarding_rule7_local_ip
/api/v1/nat_config/port_forwarding_rule/7/lan_start_port -> port_forwarding_rule7_lan_start_port
/api/v1/nat_config/port_forwarding_rule/7/lan_end_port -> port_forwarding_rule7_lan_end_port
/api/v1/nat_config/port_forwarding_rule/8/wan_start_port -> port_forwarding_rule8_wan_start_port
/api/v1/nat_config/port_forwarding_rule/8/wan_end_port -> port_forwarding_rule8_wan_end_port
/api/v1/nat_config/port_forwarding_rule/8/local_ip -> port_forwarding_rule8_local_ip
/api/v1/nat_config/port_forwarding_rule/8/lan_start_port -> port_forwarding_rule8_lan_start_port
/api/v1/nat_config/port_forwarding_rule/8/lan_end_port -> port_forwarding_rule8_lan_end_port
/api/v1/nat_config/port_forwarding_rule/9/wan_start_port -> port_forwarding_rule9_wan_start_port
/api/v1/nat_config/port_forwarding_rule/9/wan_end_port -> port_forwarding_rule9_wan_end_port
/api/v1/nat_config/port_forwarding_rule/9/local_ip -> port_forwarding_rule9_local_ip
/api/v1/nat_config/port_forwarding_rule/9/lan_start_port -> port_forwarding_rule9_lan_start_port
/api/v1/nat_config/port_forwarding_rule/9/lan_end_port -> port_forwarding_rule9_lan_end_port
/api/v1/nat_config/port_forwarding_rule/all
/api/v1/nat_config/all

MESHAGENTUPGRADE CONFIGURATION (GET):
/api/v1/meshagentupgrade/1/model_name -> meshagentupgrade_1_model_name
/api/v1/meshagentupgrade/1/firmware_version -> meshagentupgrade_1_firmware_version
/api/v1/meshagentupgrade/1/server_type -> meshagentupgrade_1_server_type
/api/v1/meshagentupgrade/1/server_ip -> meshagentupgrade_1_server_ip
/api/v1/meshagentupgrade/1/server_login -> meshagentupgrade_1_server_login
/api/v1/meshagentupgrade/1/server_password -> meshagentupgrade_1_server_password
/api/v1/meshagentupgrade/1/file_name -> meshagentupgrade_1_file_name
/api/v1/meshagentupgrade/1/reboot_time -> meshagentupgrade_1_reboot_time
/api/v1/meshagentupgrade/1/all
/api/v1/meshagentupgrade/2/model_name -> meshagentupgrade_2_model_name
/api/v1/meshagentupgrade/2/firmware_version -> meshagentupgrade_2_firmware_version
/api/v1/meshagentupgrade/2/server_type -> meshagentupgrade_2_server_type
/api/v1/meshagentupgrade/2/server_ip -> meshagentupgrade_2_server_ip
/api/v1/meshagentupgrade/2/server_login -> meshagentupgrade_2_server_login
/api/v1/meshagentupgrade/2/server_password -> meshagentupgrade_2_server_password
/api/v1/meshagentupgrade/2/file_name -> meshagentupgrade_2_file_name
/api/v1/meshagentupgrade/2/reboot_time -> meshagentupgrade_2_reboot_time
/api/v1/meshagentupgrade/2/all
/api/v1/meshagentupgrade/3/model_name -> meshagentupgrade_3_model_name
/api/v1/meshagentupgrade/3/firmware_version -> meshagentupgrade_3_firmware_version
/api/v1/meshagentupgrade/3/server_type -> meshagentupgrade_3_server_type
/api/v1/meshagentupgrade/3/server_ip -> meshagentupgrade_3_server_ip
/api/v1/meshagentupgrade/3/server_login -> meshagentupgrade_3_server_login
/api/v1/meshagentupgrade/3/server_password -> meshagentupgrade_3_server_password
/api/v1/meshagentupgrade/3/file_name -> meshagentupgrade_3_file_name
/api/v1/meshagentupgrade/3/reboot_time -> meshagentupgrade_3_reboot_time
/api/v1/meshagentupgrade/3/all
/api/v1/meshagentupgrade/4/model_name -> meshagentupgrade_4_model_name
/api/v1/meshagentupgrade/4/firmware_version -> meshagentupgrade_4_firmware_version
/api/v1/meshagentupgrade/4/server_type -> meshagentupgrade_4_server_type
/api/v1/meshagentupgrade/4/server_ip -> meshagentupgrade_4_server_ip
/api/v1/meshagentupgrade/4/server_login -> meshagentupgrade_4_server_login
/api/v1/meshagentupgrade/4/server_password -> meshagentupgrade_4_server_password
/api/v1/meshagentupgrade/4/file_name -> meshagentupgrade_4_file_name
/api/v1/meshagentupgrade/4/reboot_time -> meshagentupgrade_4_reboot_time
/api/v1/meshagentupgrade/4/all
/api/v1/meshagentupgrade/all

MESHNETWORKTOPOLOGY CONFIGURATION (POST):
/api/v1/meshnetworktopology/update <- update (use this ‘update’ to refresh the meshnetworktopology data)

MESHNETWORKTOPOLOGY CONFIGURATION (GET):
/api/v1/meshnetworktopology/update -> update
/api/v1/meshnetworktopology/agents_number -> agents_number
/api/v1/meshnetworktopology/controller/model_name -> controller_model_name
/api/v1/meshnetworktopology/controller/ip -> controller_ip
/api/v1/meshnetworktopology/controller/mac -> controller_mac
/api/v1/meshnetworktopology/controller/firmware_version -> controller_firmware_version
/api/v1/meshnetworktopology/controller/root_distance -> controller_root_distance
/api/v1/meshnetworktopology/controller/sta_number -> controller_sta_number
use ‘sta’ from 1 to controller_sta_number e.g.

/api/v1/meshnetworktopology/controller/sta/1/hostname -> controller_sta_1_hostname
/api/v1/meshnetworktopology/controller/sta/1/ip -> controller_sta_1_ip
/api/v1/meshnetworktopology/controller/sta/1/mac -> controller_sta_1_mac
/api/v1/meshnetworktopology/controller/sta/1/medium -> controller_sta_1_medium
/api/v1/meshnetworktopology/controller/sta/1/rssi -> controller_sta_1_rssi
/api/v1/meshnetworktopology/controller/all
use ‘agent’ from 1 to agents_number e.g.

/api/v1/meshnetworktopology/agent/1/model_name -> agent_1_model_name
/api/v1/meshnetworktopology/agent/1/ip -> agent_1_ip
/api/v1/meshnetworktopology/agent/1/mac -> agent_1_mac
/api/v1/meshnetworktopology/agent/1/firmware_version -> agent_1_firmware_version
/api/v1/meshnetworktopology/agent/1/root_distance -> agent_1_root_distance
/api/v1/meshnetworktopology/agent/1/backhaul/parent_mac -> agent_1_backhaul_parent_mac
/api/v1/meshnetworktopology/agent/1/backhaul/medium -> agent_1_backhaul_medium
/api/v1/meshnetworktopology/agent/1/backhaul/link_rate -> agent_1_backhaul_link_rate
/api/v1/meshnetworktopology/agent/1/backhaul/rssi -> agent_1_backhaul_rssi
/api/v1/meshnetworktopology/agent/1/backhaul/tx_packet -> agent_1_backhaul_tx_packet
/api/v1/meshnetworktopology/agent/1/backhaul/rx_packet -> agent_1_backhaul_rx_packet
/api/v1/meshnetworktopology/agent/1/backhaul/tx_error_packet -> agent_1_backhaul_tx_error_packet
/api/v1/meshnetworktopology/agent/1/backhaul/rx_error_packet -> agent_1_backhaul_rx_error_packet
/api/v1/meshnetworktopology/agent/1/sta_number -> agent_1_sta_number
use ‘agent’ from 1 to agents_number,
use ‘sta’ from 1 to ‘sta_number’ for chosed ‘agent’ (e.g. agent_1_sta_number):

/api/v1/meshnetworktopology/agent/1/sta/1/hostname -> agent_1_sta_1_hostname
/api/v1/meshnetworktopology/agent/1/sta/1/ip -> agent_1_sta_1_ip
/api/v1/meshnetworktopology/agent/1/sta/1/mac -> agent_1_sta_1_mac
/api/v1/meshnetworktopology/agent/1/sta/1/medium -> agent_1_sta_1_medium
/api/v1/meshnetworktopology/agent/1/sta/1/rssi -> agent_1_sta_1_rssi
use ‘agent’ from 1 to agents_number e.g.

/api/v1/meshnetworktopology/agent/1/all

Table of Contents