Manage Wi-Fi calling service profiles.
- Trigger AP Action
Get APs by AP-Group
Delete APs
Get APs
Add APs
Get Result for Import APs from CSV File
Delete AP
Get AP
Update AP
Get AP Basic Service Set Coloring Settings
Update AP Basic Service Set Coloring Settings
Get AP Capabilities
Get AP Default Regulatory-Channels
Reset AP Client Admission Control Settings
Get AP Client Admission Control Settings
Update AP Client Admission Control Settings
Get DHCP Lease Times
Get DHCP Pool Usages
Reset AP Directed Multicast Settings
Get AP Directed Multicast Settings
Update AP Directed Multicast Settings
Update AP Position
Reset AP LAN-Ports
Get AP LAN-Ports
Update AP LAN-Ports
Reset AP LED
Get AP LED
Update AP LED
Download AP Log
Get AP Mesh Settings
Update AP Mesh Settings
Reset AP Network Settings
Get AP Network Settings
Update AP Network Settings
Stop Packet Capture
Get Packet Capture State
Start Packet Capture
Delete AP Picture
Get AP Picture
Upload AP Picture
Reset AP Radio Customization
Get AP Radio
Update AP Radio
Reset AP SNMP Agent Settings
Get AP SNMP Agent Settings
Update AP SNMP Agent Settings
Reset AP Customization
Get AP Customization
Update AP Customization
Get AP Band Mode
Update AP Band Mode
Get AP Client Admission Control Settings
Update AP Client Admission Control Settings
Get AP IoT Settings
Update AP IoT Settings
Get AP LAN-Ports
Update AP LAN-Ports
Reset AP Sticky Client Steering Settings
Get AP Sticky Client Steering Settings
Update AP Sticky Client Steering Settings
Trigger AP Action
Wi-Fi API and Model Documentation (17.3.3.144)
Download OpenAPI description
Overview
License
Languages
Servers
Asian region
https://api.asia.ruckus.cloud/
European region
https://api.eu.ruckus.cloud/
North American region
https://api.ruckus.cloud/
- Asian region
https://api.asia.ruckus.cloud/venues/aps/{serialNumber}
- European region
https://api.eu.ruckus.cloud/venues/aps/{serialNumber}
- North American region
https://api.ruckus.cloud/venues/aps/{serialNumber}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "apGroupId": "string", "bssColoring": { "bssColoringEnabled": false, "useVenueSettings": true }, "clientAdmissionControl": { "enable24G": false, "enable50G": false, "maxRadioLoad24G": 75, "maxRadioLoad50G": 75, "minClientCount24G": 10, "minClientCount50G": 20, "minClientThroughput24G": 0, "minClientThroughput50G": 0, "useVenueSettings": true }, "clientCount": 0, "description": "string", "deviceGps": { "latitude": "string", "longitude": "string" }, "externalIp": "null", "firmware": "null", "indoorModel": false, "ip": "null", "lanPorts": { "lanPorts": [ … ], "poeOut": false, "useVenueSettings": false }, "lastContacted": "null", "lastUpdated": "null", "mac": "null", "meshRole": "null", "model": "null", "name": "string", "poePortStatus": "null", "position": { "floorplanId": "string", "xPercent": 0, "yPercent": 0 }, "radio": { "apRadioParams24G": { … }, "apRadioParams50G": { … }, "apRadioParams6G": { … }, "apRadioParamsDual5G": { … }, "enable24G": false, "enable50G": false, "enable6G": false, "useVenueSettings": true }, "serialNumber": "string", "softDeleted": false, "softDeletedDate": "2019-08-24T14:15:22Z", "state": "InSetupPhase", "subState": "NeverContactedCloud", "tags": [ "string" ], "uptime_seconds": 0, "venueId": "string" }
- Asian region
https://api.asia.ruckus.cloud/venues/aps/{serialNumber}
- European region
https://api.eu.ruckus.cloud/venues/aps/{serialNumber}
- North American region
https://api.ruckus.cloud/venues/aps/{serialNumber}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "action": "ping", "targetHost": "string" }
Response
application/json
{ "requestId": "string", "response": { "response": "string" } }
- Asian region
https://api.asia.ruckus.cloud/venues/aps/{serialNumber}
- European region
https://api.eu.ruckus.cloud/venues/aps/{serialNumber}
- North American region
https://api.ruckus.cloud/venues/aps/{serialNumber}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "apGroupId": "string", "description": "string", "deviceGps": { "latitude": "string", "longitude": "string" }, "model": "null", "name": "string", "position": { "floorplanId": "string", "xPercent": 0, "yPercent": 0 }, "serialNumber": "string", "tags": [ "string" ], "venueId": "string" }
Response
application/json
{ "requestId": "string" }
Client Isolation Allowlist
Manage client isolation allowlists.
Client isolation features, when enabled, prevent clients residing on a common VLAN from exchanging packets with each other. Client isolation is enforced by APs working at layer 2 (bridging). If client isolation is needed between VLANs/IP subnets, routers must also be configured to prevent packet exchange at layer 3. A client isolation allowlist provides the capability for administrators to configure exceptions to this isolation behavior. For example, an administrator may want to allow clients on a public network to access a printer in a common area of their venue. If so, the MAC and IP addresses of the printer (or any excepted device) can be configured on the client isolation allowlist.
Client isolation can be used in conjunction with walled gardens for public networks. Walled gardens provide limited access to services prior to client authentication whereas client isolation allowlists provide connectivity options post authentication.
Client isolation does not work when clients are assigned static IP addresses. For this reason, Ruckus recommends using DHCP lease reservations in lieu of static IP addresses when using this feature. Administrators may also want to consider use of the force DHCP option, available during wireless network configuration.
Complications to client isolation can arise when the VLAN's default gateway employs VRRP or HSRP for high availability or when Multicast DNS Proxy is configured on the same WLAN as the allowlist. If either of these situations applies in your network, please contact Ruckus customer support for assistance.
Operations
Rogue AP Detection Policy
Manage rogue AP detection policies.
Rogue APs are Wi-Fi APs which are in radio range of your Wi-Fi network, but are unknown to the Ruckus cloud. For example, these may be APs in installed your venues without explicit authorization from your administrators, whether added by a well-meaning employee or by a malicious attacker; as such, they could be on the same LAN as your authorized APs. They could also be APs installed in nearby venues (for example, if your venue is part of a multi-tenant facility). Rogue classification polices help to automatically classify these unknown APs by setting up rules which trigger a rogue AP report when specific-rogue detection criteria are met.
Operations