Skip to main content

Commands -- Mesh

POST /api/cmd.mesh.discover

⚠️ Alpha API

Trigger Integrated AP/External AP to scan for default APs.

Available in 8.4.2 or later

Input Parameters

FieldTypeRequiredDescription
apListarrayList of AP serial numbers to scan

Response

FieldTypeDescription
apListarrayList of Capable_AP objects

Capable_AP Object:

FieldTypeDescription
serialNumberstringSerial number of the AP
statusstringonline or scanning

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"apList":["19FF-ABCD-1111","19FF-ABCE-2222"]}' \
http://192.168.1.1/api/cmd.mesh.discover
{
"stat": "ok",
"response": {
"apList": [
{
"serialNumber": "19FF-ABCD-1111",
"status": "scanning"
},
{
"serialNumber": "19FF-ABCE-2222",
"status": "scanning"
}
]
}
}

GET /api/cmd.mesh.discover.result

⚠️ Alpha API

Retrieve discovery results for default APs.

Available in 8.4.2 or later

Response

FieldTypeDescription
apListarrayList of Capable_AP objects
candidateListarrayList of Candidate objects that can accept mesh requests

Capable_AP Object:

FieldTypeDescription
serialNumberstringSerial number of the AP
statusstringonline or scanning

Candidate Object:

FieldTypeDescription
idstring (MAC)Candidate ID
bssListarrayList of Discovered_BSS objects
statusstringnew or adopting

Discovered_BSS Object:

FieldTypeDescription
bssidstring (MAC)BSSID of the candidate
serialNumberstringSerial number of scanning AP
rssiintegerSignal strength observed by the scanning AP
channelnumberChannel number
lastUpdatenumberTime since last update in seconds

cURL Example

curl -b cookies.txt http://192.168.1.1/api/cmd.mesh.discover.result
{
"stat": "ok",
"response": {
"apList": [
{
"serialNumber": "19FF-ABCD-1111",
"status": "scanning"
},
{
"serialNumber": "19FF-ABCE-2222",
"status": "scanning"
}
],
"candidates": {
"order": ["A8:C0:EA:34:C7:A0"],
"A8:C0:EA:34:C7:A0": {
"bssList": [
{
"bssid": "A8:C1:EA:34:C7:A4",
"serialNumber": "19FF-ABCD-1111",
"rssi": -25,
"channel": 11,
"lastUpdate": 1
},
{
"bssid": "A8:C1:EA:34:C7:A4",
"serialNumber": "19FF-ABCE-2222",
"rssi": -33,
"channel": 11,
"lastUpdate": 1
},
{
"bssid": "A8:C1:EA:34:C7:A8",
"serialNumber": "19FF-ABCD-1111",
"rssi": -32,
"channel": 36,
"lastUpdate": 1
},
{
"bssid": "A8:C1:EA:34:C7:A8",
"serialNumber": "19FF-ABCE-2222",
"rssi": -32,
"channel": 36,
"lastUpdate": 1
}
],
"status": "new"
}
}
}
}

POST /api/cmd.mesh.request

⚠️ Alpha API

Trigger Integrated AP/External AP to send a mesh request to the target candidate.

Available in 8.4.2 or later

Input Parameters

FieldTypeRequiredDescription
candidateIdstring (MAC)Target candidate ID

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"candidateId":"00:1A:DD:FF:FF:FF"}' \
http://192.168.1.1/api/cmd.mesh.request
{
"stat": "ok"
}