WiiM HTTP API Docs
Search K

Appearance

Network​

Get the network status

Get the static IP information​

GET
/getStaticIpInfo

Makes a call to https://10.10.10.254/httpapi.asp?command=getStaticIpInfo

If the WiiM device is configured to use DHCP, the above string values will be empty (see the ethernet related keys).

Responses​

Successful response

text/html
JSON
{
  
"wlanStaticIp": "string",
  
"wlanGateWay": "string",
  
"wlanDnsServer": "string",
  
"wlanStaticIpEnable": 0,
  
"ethStaticIp": "string",
  
"ethGateWay": "string",
  
"ethDnsServer": "string",
  
"ethStaticIpEnable": 0
}

Playground​

Samples​

Deprecated

Query networking status​

GET
/getStaticIP

Query current networking status

Responses​

Successful response

text/html
JSON
"string"

Playground​

Samples​

Get the connection status​

GET
/wlanGetConnectState

Makes a call to
https://10.10.10.254/httpapi.asp?command=wlanGetConnectState

Note the return result is not in json.

Return string:

Return string Description

PROCESS In progress

PAIRFAIL Wrong password

FAIL Connect fail

OK connected

Responses​

Successful response

text/html
JSON
"PROCESS"

Playground​

Samples​

Set static WLAN network config​

GET
/setWlanStaticIp:{IpAddress}:{GatewayIp}:{DnsServerIp}

Example: https://10.10.10.254/httpapi.asp?command=setWlanStaticIp:ipAddr=192.168.1.100/24:gateWay=192.168.1.1:dnsServer=8.8.8.8

Keyword args:

  • ipAddr: Static IP address to set + netmask
  • gateWay: Gateway
  • dnsServer: The DNS Server (default: 8.8.8.8)

Parameters​

Path Parameters

IpAddress*

Static IP address to set + netmask

Type
string
Required
Example"192.168.0.123/24"
GatewayIp*

Gateway IP address

Type
string
Required
Example"192.168.0.1"
DnsServerIp*

The DNS Server (default: 8.8.8.8)

Type
string
Required
Example"8.8.8.8"

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Set static Ethernet network config​

GET
/setEthStaticIp:{IpAddress}:{GatewayIp}:{DnsServerIp}

Example: https://10.10.10.254/httpapi.asp?command=setEthStaticIp:ipAddr=192.168.1.100/24:gateWay=192.168.1.1:dnsServer=8.8.8.8

Keyword args:

  • ipAddr: Static IP address to set + netmask
  • gateWay: Gateway
  • dnsServer: The DNS Server (default: 8.8.8.8)

Parameters​

Path Parameters

IpAddress*

Static IP address to set + netmask

Type
string
Required
Example"192.168.0.123/24"
GatewayIp*

Gateway IP address

Type
string
Required
Example"192.168.0.1"
DnsServerIp*

The DNS Server (default: 8.8.8.8)

Type
string
Required
Example"8.8.8.8"

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Change the SSID name of the device​

GET
/setSSID:{value}

Example: http://10.10.10.254/httpapi.asp?command=setSSID:value

Sets a new network name (SSID) of the device in hexadecimal format

Parameters​

Path Parameters

value*

The new SSID name to set for the device, in hexadecimal format.

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Setting the password WIFI​

GET
/setNetwork:{n}:{password}

Example: http://10.10.10.254/httpapi.asp?command=setNetwork:1:password

Setting a new password using letters and / or numbers and crossing of setnetwork setting: 1 (Securing WIFI network (WPAPSK) in contrast, setnetwork: 0 (OPEN) makes the network open WIFI.

No response The system restarts after the validation of the new password.

Parameters​

Path Parameters

n*

Network security type, where 1 secures the WIFI network with WPAPSK and 0 makes the network open.

Type
integer
Required
Valid values
01
password*

The new password to set for the WIFI network, using letters and/or numbers.

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Get the preferred DNS server​

GET
/getNetworkPreferDNS

...

Responses​

Successful response

Playground​

Samples​

Get the WLAN band configuration​

GET
/getWlanBandConfig

...

Responses​

Successful response

Playground​

Samples​

Get the WLAN roaming configuration​

GET
/getWlanRoamConfig

...

Responses​

Successful response

Playground​

Samples​

Get IPV6 enable status​

GET
/getIPV6Enable

...

Responses​

Successful response

Playground​

Samples​

Stop WIFI signal​

GET
/setPowerWifiDown

Example: http://10.10.10.254/httpapi.asp?command=setPowerWifiDown

Turns off the wifi

Responses​

Successful response

Playground​

Samples​

WLAN connect to hidden AP​

GET
/wlanConnectHideAp:{str}

...

Parameters​

Path Parameters

str*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

WLAN connect to hidden AP with extra parameters​

GET
/wlanConnectHideApEx:{str1}:{str2}:{str3}

...

Parameters​

Path Parameters

str1*

Unknown

Type
string
Required
str2*

Unknown

Type
string
Required
str3*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Get the network configuration​

GET
/getNetwork

...

Responses​

Successful response

Playground​

Samples​

Get WLAN AP list​

GET
/wlanGetApListEx

...

Returns: {"res":"0"}

Responses​

Successful response

text/html
JSON
{
  
"res": "0"
}

Playground​

Samples​

Set hide SSID​

GET
/setHideSSID:{str}

...

Parameters​

Path Parameters

str*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Set network with AES encryption​

GET
/setNetworkExAES:{n}:{password}

...

Parameters​

Path Parameters

n*

Unknown

Type
integer
Required
Valid values
01
password*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Set WLAN band configuration​

GET
/setWlanBandConfig:{str}

...

Parameters​

Path Parameters

str*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Set WLAN connect disable​

GET
/setWlanConnectDisable:{str}

...

Parameters​

Path Parameters

str*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Set WLAN roam configuration​

GET
/setWlanRoamConfig:{str}

...

Parameters​

Path Parameters

str*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Set network preferred DNS​

GET
/setNetworkPreferDNS:{str}

...

Parameters​

Path Parameters

str*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Get WLAN AP list​

GET
/wlanGetApFullList

...

Responses​

Successful response

Playground​

Samples​

Wlan switch connected AP​

GET
/wlanSwitchConnectedAp:ssid={ssid}:bssid={bssid}

...

Parameters​

Path Parameters

ssid*

Unknown

Type
string
Required
bssid*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Set IPv6 enable​

GET
/setIPV6Enable:{str}

...

Parameters​

Path Parameters

str*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Get WLAN connect disable status​

GET
/getWlanConnectDisableStatus

...

Responses​

Successful response

Playground​

Samples​

Get network health status​

GET
/getNetworkHealth

...

Returns: {"wlanDhcpTime":0, "ethDhcpTime":1, "wlanIpChanged":0, "wlanRoamingOn":0, "wlanBand":0, "wlanHistoryNum":0, "disconnectedCount":1, "lastDisconnectedTime":1, "ethDisconnectedCount":0, "lastDisconnectedMsg":"", "ethNotReady":0, "pingCheckFailedCount":0, "wlanConnectTime":0, "wlanAbnormalRebootTimes":0, "wlanIsStaticIp":0, "ethIsStaticIp":0}

Responses​

Successful response

text/html
JSON
{
  
"wlanDhcpTime": 0,
  
"ethDhcpTime": 0,
  
"wlanIpChanged": 0,
  
"wlanRoamingOn": 0,
  
"wlanBand": 0,
  
"wlanHistoryNum": 0,
  
"disconnectedCount": 0,
  
"lastDisconnectedTime": 0,
  
"ethDisconnectedCount": 0,
  
"lastDisconnectedMsg": "string",
  
"ethNotReady": 0,
  
"pingCheckFailedCount": 0,
  
"wlanConnectTime": 0,
  
"wlanAbnormalRebootTimes": 0,
  
"wlanIsStaticIp": 0,
  
"ethIsStaticIp": 0
}

Playground​

Samples​

WPS Channel​

GET
/wpscannel

Example: http://10.10.10.254/httpapi.asp?command=wpscannel

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

WPS Client Mode​

GET
/wpsclientmode

Example: http://10.10.10.254/httpapi.asp?command=wpsclientmode

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

WPS Server Mode​

GET
/wpsservermode

Example: http://10.10.10.254/httpapi.asp?command=wpsservermode

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

Powered by VitePress OpenAPI