Skip to main content

Configuration -- Wireless

GET /api/config.ssid.profile​

Obtain the SSID profile information.

Available in 7.1.1 or later

Input Parameters​

FieldTypeRequiredDescription
idarrayoptionalList of SSID profile IDs. Returns all profiles if omitted.

Response​

FieldTypeDescription
orderarrayOrder of SSID profile IDs
<profile_id>objectSSID profile information

SSID_Profile Object:

FieldTypeDescription
namestringSSID of the profile
enablebooleanEnabled as Local AP. Always false if device doesn't support Wi-Fi.
frequencyarray2.4GHz, 5GHz (absent when disabled; Wi-Fi devices only)
vlanIdintegerVLAN ID (absent if using LAN)
captivePortalbooleanUses captive portal
incontrolManagedbooleanManaged by InControl
broadcastbooleanBroadcast the SSID
securityobjectSecurity settings

Security Object:

FieldTypeDescription
policystringWPA2 Personal or WPA/WPA2 Personal
wpa2PersonalobjectWPA2 Personal settings
wpaWpa2PersonalobjectWPA/WPA2 Personal settings
ppskarrayPrivate Pre-Shared Key config

WPA2_Personal Object:

FieldTypeDescription
fastTransitionbooleanFast Transition for WPA2 (not in WPA/WPA2 Personal)
keystringPre-shared key

PPSK Object:

FieldTypeDescription
namestringReference name
keystringWPA/WPA2/WPA3 Personal Key in plaintext
macstring (MAC)MAC address this PPSK applies to
vlanIdintegerVLAN ID for this PPSK (untagged LAN if not specified)

cURL Example​

curl -b cookies.txt \
"http://192.168.1.1/api/config.ssid.profile?id=1&id=2"
{
"stat": "ok",
"response": {
"1": {
"name": "Main SSID",
"enable": true,
"captivePortal": true,
"incontrolManaged": false,
"broadcast": true,
"security": {
"policy": "WPA2 Personal",
"wpa2Personal": {
"fastTransition": true,
"key": "pas53or2"
}
}
},
"2": {
"name": "Guest SSID",
"enable": true,
"captivePortal": true,
"incontrolManaged": false,
"broadcast": true,
"vlanId": 1,
"security": {
"policy": "WPA2 Personal",
"wpa2Personal": {
"fastTransition": false,
"key": "pass3ord"
}
}
},
"order": [1, 2]
}
}

POST /api/config.ssid.profile​

Update the SSID profile. Only provided fields will be affected.

Available in 7.1.1 or later

Input Parameters​

FieldTypeRequiredDescription
actionstring✅update
idnumber✅Profile ID to update
namestringoptionalSSID name
enablebooleanoptionalEnable as Local AP (Wi-Fi devices only)
frequencyarrayoptional2.4GHz, 5GHz. Both used if absent and SSID is enabled.
vlanIdintegeroptionalVLAN ID
broadcastbooleanoptionalBroadcast the SSID
securityobjectoptionalSecurity settings

Security Update Object:

FieldTypeRequiredDescription
policystringoptionalWPA2 Personal or WPA/WPA2 Personal
wpa2PersonalobjectoptionalWPA2 Personal settings
wpaWpa2PersonalobjectoptionalWPA/WPA2 Personal settings
ppskarrayoptionalPrivate Pre-Shared Key settings

WPA2 Personal Update:

FieldTypeRequiredDescription
fastTransitionbooleanoptionalFast Transition (WPA2 only)
keystringoptionalPre-shared key (8--63 chars or 64-char HEX)

cURL Example​

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"action":"update","id":"1","enable":true,"frequency":["2.4GHz","5GHz"],"security":{"wpa2Personal":{"key":"thisIsNewPassword"}}}' \
http://192.168.1.1/api/config.ssid.profile
{
"stat": "ok",
"response": {
"1": {
"name": "Main SSID",
"enable": true,
"captivePortal": true,
"incontrolManaged": false,
"broadcast": true,
"security": {
"policy": "WPA2 Personal",
"wpa2Personal": {
"fastTransition": true,
"key": "thisIsNewPassword"
}
}
},
"order": [1]
}
}

GET /api/config.mesh​

Obtain the wireless mesh configuration.

Available in 8.3.2 or later

Response​

FieldTypeDescription
orderarrayOrder of mesh profile IDs
<profile_id>objectMesh profile information

Mesh_Profile Object:

FieldTypeDescription
enablebooleanProfile enabled
profileIdarrayAP profile IDs using this mesh network
meshIdstringMesh ID
passphrasestringPassphrase (minimum 8 characters)
frequencyBandstring2.4 GHz or 5 GHz

cURL Example​

curl -b cookies.txt http://192.168.1.1/api/config.mesh
{
"stat": "ok",
"response": {
"1": {
"enable": true,
"meshId": "522",
"passphrase": "222246645646",
"frequencyBand": "2.4 GHz"
},
"order": [1]
}
}

POST /api/config.mesh​

Add, update, or remove mesh profiles.

Available in 8.3.2 or later

Add a Mesh Profile​

FieldTypeRequiredDescription
actionstring✅add
listarray✅List of mesh profile objects

Mesh Profile (Add):

FieldTypeRequiredDescription
idinteger✅Profile ID
meshIdstring✅Mesh ID
profileIdarray or nulloptionalAP profile IDs. null = no profiles assigned.
passphrasestring✅Passphrase (min 8 characters)
frequencyBandstring✅2.4 GHz or 5 GHz

Update a Mesh Profile​

FieldTypeRequiredDescription
actionstring✅update
listarray✅List of mesh profile objects

Mesh Profile (Update):

FieldTypeRequiredDescription
idinteger✅Profile ID to update
meshIdstringoptionalMesh ID
profileIdarray or nulloptionalAP profile IDs. null = unassign. Absent = no change.
passphrasestringoptionalPassphrase (min 8 characters)
frequencyBandstringoptional2.4 GHz or 5 GHz

Remove a Mesh Profile​

FieldTypeRequiredDescription
actionstring✅remove
listarray✅List of objects with id (integer) to remove

cURL Examples​

Update:

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"action":"update","list":[{"id":1,"frequencyBand":"2.4 GHz"}]}' \
http://192.168.1.1/api/config.mesh

Remove:

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"action":"remove","list":[{"id":1}]}' \
http://192.168.1.1/api/config.mesh