Manage Wi-Fi calling service profiles.
/
Get Default Rules for QoS...
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/networks
- European region
https://api.eu.ruckus.cloud/networks
- North American region
https://api.ruckus.cloud/networks
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
[ "string" ]
Response
application/json
{ "requestId": "string" }
- Asian region
https://api.asia.ruckus.cloud/networks
- European region
https://api.eu.ruckus.cloud/networks
- North American region
https://api.ruckus.cloud/networks
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
[ { "id": "string", "name": "string", "tenantId": "string", "type": "string" } ]
Bodyapplication/jsonrequired
One of:
- AAANetwork
- DpskNetwork
- GuestNetwork
- Hotspot20Network
- OpenNetwork
- PskNetwork
AAA Wi-Fi network
WLAN
MAC address authentication configuration
- Asian region
https://api.asia.ruckus.cloud/networks
- European region
https://api.eu.ruckus.cloud/networks
- North American region
https://api.ruckus.cloud/networks
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "name": "string", "type": "string", "accountingRadiusId": "string", "authRadiusId": "string", "description": "string", "enableAccountingProxy": false, "enableAuthProxy": false, "useCertificateTemplate": false, "wlan": { "advancedCustomization": { … }, "bypassCNA": false, "bypassCPUsingMacAddressAuthentication": false, "enabled": true, "macAddressAuthenticationConfiguration": { … }, "managementFrameProtection": "Disabled", "ssid": "string", "vlanId": 1, "wlanSecurity": "WPA2Enterprise" } }
Response
application/json
{ "requestId": "string", "response": { "id": "string", "name": "string", "tenantId": "string", "type": "string", "accountingRadiusId": "string", "authRadiusId": "string", "description": "string", "enableAccountingProxy": false, "enableAuthProxy": false, "useCertificateTemplate": false, "venues": [ … ], "wlan": { … } } }
- Asian region
https://api.asia.ruckus.cloud/networks/qosMapSets
- European region
https://api.eu.ruckus.cloud/networks/qosMapSets
- North American region
https://api.ruckus.cloud/networks/qosMapSets
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "rules": [ { … } ] }
- Asian region
https://api.asia.ruckus.cloud/networks/wisprProviders
- European region
https://api.eu.ruckus.cloud/networks/wisprProviders
- North American region
https://api.ruckus.cloud/networks/wisprProviders
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "providers": [ { … } ] }
- Asian region
https://api.asia.ruckus.cloud/networks/{networkId}
- European region
https://api.eu.ruckus.cloud/networks/{networkId}
- North American region
https://api.ruckus.cloud/networks/{networkId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "requestId": "string" }
- Asian region
https://api.asia.ruckus.cloud/networks/{networkId}
- European region
https://api.eu.ruckus.cloud/networks/{networkId}
- North American region
https://api.ruckus.cloud/networks/{networkId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "id": "string", "name": "string", "tenantId": "string", "type": "AAANetwork", "accountingRadiusId": "string", "authRadiusId": "string", "description": "string", "enableAccountingProxy": false, "enableAuthProxy": false, "useCertificateTemplate": false, "venues": [ { … } ], "wlan": { "advancedCustomization": { … }, "bypassCNA": false, "bypassCPUsingMacAddressAuthentication": false, "enabled": true, "macAddressAuthenticationConfiguration": { … }, "managementFrameProtection": "Disabled", "ssid": "string", "vlanId": 1, "wlanSecurity": "WPA2Enterprise" } }
Bodyapplication/jsonrequired
One of:
- AAANetwork
- DpskNetwork
- GuestNetwork
- Hotspot20Network
- OpenNetwork
- PskNetwork
AAA Wi-Fi network
WLAN
MAC address authentication configuration
- Asian region
https://api.asia.ruckus.cloud/networks/{networkId}
- European region
https://api.eu.ruckus.cloud/networks/{networkId}
- North American region
https://api.ruckus.cloud/networks/{networkId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "name": "string", "type": "string", "accountingRadiusId": "string", "authRadiusId": "string", "description": "string", "enableAccountingProxy": false, "enableAuthProxy": false, "useCertificateTemplate": false, "wlan": { "advancedCustomization": { … }, "bypassCNA": false, "bypassCPUsingMacAddressAuthentication": false, "enabled": true, "macAddressAuthenticationConfiguration": { … }, "managementFrameProtection": "Disabled", "ssid": "string", "vlanId": 1, "wlanSecurity": "WPA2Enterprise" } }
Response
application/json
{ "requestId": "string" }
- Asian region
https://api.asia.ruckus.cloud/x509certs
- European region
https://api.eu.ruckus.cloud/x509certs
- North American region
https://api.ruckus.cloud/x509certs
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "info": "string", "interCerts": [ { … } ], "rootCert": { "certData": "string", "fileName": "string", "isRootCert": false } }
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