POST /system/network/adapters/wireless/primary/client/scan
This resource makes the controller search and list the available access points that are within range.
If no Wi-Fi key is plugged-in you will get a 503 Service Unavailable error.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
Object Name: WirelessNetwork
Property Name | Type | Description | Method |
---|---|---|---|
BSSID | String | GET | |
SSID | String | The network name. | GET |
EncryptionType | String | The type of the network encryption. | GET |
Frequency | Integer | GET | |
Level | Integer | GET |
Object Name: WirelessNetworks
Property Name | Type | Description | Method |
---|---|---|---|
WirelessNetworks | Array |
This contains an array of wireless networks. | GET |
URL Example: https://0.0.0.0/api/rest/v1/system/network/adapters/wireless/primary/client/scan
[
{
"bssid": "14:cc:20:19:24:02",
"ssid": "MyDcAccessPoint",
"encryptionType": "WPA2",
"frequency": 2412,
"level": -72
},
{
"bssid": "e8:de:27:0a:5a:98",
"ssid": "BAS_UC3",
"encryptionType": "WPA2",
"frequency": 2412,
"level": -76
},
{
"bssid": "e8:de:27:0f:e1:24",
"ssid": "ECLYPSE-CF1632",
"encryptionType": "WPA2",
"frequency": 2412,
"level": -52
},
{
"bssid": "14:cc:20:10:58:00",
"ssid": "ECY_VAV_A1_1",
"encryptionType": "WPA2",
"frequency": 2412,
"level": -74
},
{
"bssid": "e8:de:27:05:70:e5",
"ssid": "S1000_10214",
"encryptionType": "WPA2",
"frequency": 2412,
"level": -52
},
{
"bssid": "e8:94:f6:20:dd:ca",
"ssid": "ECY-AC",
"encryptionType": "WPA2",
"frequency": 2412,
"level": -50
},
{
"bssid": "14:cc:20:10:19:70",
"ssid": "ECY_VAV_A6_1",
"encryptionType": "WPA2",
"frequency": 2412,
"level": -72
}
]
URL Example: https://0.0.0.0/api/rest/v1/system/network/adapters/wireless/primary/client/scan
<?xml version="1.0" encoding="utf-8"?>
<WirelessNetworks>
<WirelessNetwork>
<BSSID>00:15:70:cf:29:90</BSSID>
<SSID>DC_Prod</SSID>
<EncryptionType>WPA2</EncryptionType>
<Frequency>2412</Frequency>
<Level>-70</Level>
</WirelessNetwork>
<WirelessNetwork>
<BSSID>e8:de:27:05:70:e5</BSSID>
<SSID>S1000_10214</SSID>
<EncryptionType>WPA2</EncryptionType>
<Frequency>2412</Frequency>
<Level>-46</Level>
</WirelessNetwork>
<WirelessNetwork>
<BSSID>14:cc:20:19:24:2d</BSSID>
<SSID>MyDcHotSpot</SSID>
<EncryptionType>WPA2</EncryptionType>
<Frequency>2412</Frequency>
<Level>-72</Level>
</WirelessNetwork>
<WirelessNetwork>
<BSSID>e8:94:f6:14:f4:b8</BSSID>
<SSID>ECYS_48</SSID>
<EncryptionType>WPA2</EncryptionType>
<Frequency>2437</Frequency>
<Level>-62</Level>
</WirelessNetwork>
<WirelessNetwork>
<BSSID>e8:94:f6:20:4d:c4</BSSID>
<SSID>ECLYPSE-CD4701</SSID>
<EncryptionType>WPA2</EncryptionType>
<Frequency>2437</Frequency>
<Level>-50</Level>
</WirelessNetwork>
<WirelessNetwork>
<BSSID>14:cc:20:13:07:10</BSSID>
<SSID>ECLYPSE-kridder</SSID>
<EncryptionType>WPA2</EncryptionType>
<Frequency>2437</Frequency>
<Level>-44</Level>
</WirelessNetwork>
<WirelessNetwork>
<BSSID>e8:de:27:0f:e1:1a</BSSID>
<SSID>ECY051-BDT-SW-AP</SSID>
<EncryptionType>WPA2</EncryptionType>
<Frequency>2437</Frequency>
<Level>-68</Level>
</WirelessNetwork>
</WirelessNetworks>