Skip to content

Overview

Rate Limit

For the Wifi REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
Download OpenAPI description
Languages
Servers
Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.ruckus.cloud/

Wi-Fi Calling Service Profile

Manage Wi-Fi calling service profiles.

Operations

Wi-Fi Network Activation

Manage Wi-Fi network-venue activation relationships.

Operations

AP

Manage APs including pinging, trace-routing, resetting, rebooting, floor-plan positioning and LAN-Ports settings.

Operations

L3ACL Policy

Manage layer-3 ACL policy profiles.

Operations

RADIUS Profile

Manage RADIUS server profiles.

Operations

Syslog Server Profile

Manage Syslog server profiles.

Operations

Wi-Fi Network

Managing the relationships for Wi-Fi network activation within venue associations.

Operations

Application Policy

Manage application policy profiles.

Operations

AP Group

Manage AP-Groups.

Operations

Client

Manage client connections.

Operations

DHCP Configuration Service Profile

Manage DHCP configuration service profiles.

Operations

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

AP SNMP Agent Profile

Manage AP SNMP policy profiles.

Operations

Delete AP SNMP Agent ProfilesDeprecated

Request

Delete a list of AP SNMP agent profiles.

Bodyapplication/jsonrequiredArray [
string
]
application/json
[ "string" ]

Responses

Accepted

Bodyapplication/json
requestIdstring
Response
application/json
{ "requestId": "string" }

Get AP SNMP Agent ProfilesDeprecated

Request

Get the AP SNMP agent profiles.

No request payload

Responses

OK

Bodyapplication/jsonArray [
idstringread-only
policyNamestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
snmpV2AgentsArray of objects(ApSnmpV2Agent)[ 0 .. 2 ] items
snmpV3AgentsArray of objects(ApSnmpV3Agent)[ 0 .. 2 ] items
tenantIdstringread-only
]
Response
application/json
[ { "id": "string", "policyName": "string", "snmpV2Agents": [], "snmpV3Agents": [], "tenantId": "string" } ]

Create AP SNMP Agent ProfileDeprecated

Request

Create a new AP SNMP agent profile.

Bodyapplication/jsonrequired
policyNamestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
snmpV2AgentsArray of objects(ApSnmpV2Agent)[ 0 .. 2 ] items
snmpV3AgentsArray of objects(ApSnmpV3Agent)[ 0 .. 2 ] items
application/json
{ "policyName": "string", "snmpV2Agents": [ {} ], "snmpV3Agents": [ {} ] }

Responses

Accepted

Bodyapplication/json
requestIdstring
responseobject(ApSnmpAgentProfile)

AP SNMP agent profile.

Response
application/json
{ "requestId": "string", "response": { "id": "string", "policyName": "string", "snmpV2Agents": [], "snmpV3Agents": [], "tenantId": "string" } }

Delete AP SNMP Agent ProfileDeprecated

Request

Delete a AP SNMP agent profile.

Path
apSnmpProfileIdstringrequired

AP SNMP Agent Profile ID

No request payload

Responses

Accepted

Bodyapplication/json
requestIdstring
Response
application/json
{ "requestId": "string" }

Get AP SNMP ProfileDeprecated

Request

Get the details for this AP SNMP profile.

Path
apSnmpProfileIdstringrequired

AP SNMP Agent Profile ID

No request payload

Responses

OK

Bodyapplication/json
idstringread-only
policyNamestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
snmpV2AgentsArray of objects(ApSnmpV2Agent)[ 0 .. 2 ] items
snmpV3AgentsArray of objects(ApSnmpV3Agent)[ 0 .. 2 ] items
tenantIdstringread-only
Response
application/json
{ "id": "string", "policyName": "string", "snmpV2Agents": [ {} ], "snmpV3Agents": [ {} ], "tenantId": "string" }

Update AP SNMP Agent ProfileDeprecated

Request

Update a AP SNMP agent profile.

Path
apSnmpProfileIdstringrequired

AP SNMP Agent Profile ID

Bodyapplication/jsonrequired
policyNamestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
snmpV2AgentsArray of objects(ApSnmpV2Agent)[ 0 .. 2 ] items
snmpV3AgentsArray of objects(ApSnmpV3Agent)[ 0 .. 2 ] items
application/json
{ "policyName": "string", "snmpV2Agents": [ {} ], "snmpV3Agents": [ {} ] }

Responses

Accepted

Bodyapplication/json
requestIdstring
Response
application/json
{ "requestId": "string" }

Get AP SNMP Agent Profile AP UsageDeprecated

Request

Get a list of APs of the AP SNMP agent profile.

Path
apSnmpProfileIdstringrequired

AP SNMP Agent Profile ID

Bodyapplication/jsonrequired
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 25
searchStringstring

Search by AP name or venue name.

sortFieldstring

AP name or venue name only.

sortOrderstring
Enum"ASC""DESC"
application/json
{ "page": 1, "pageSize": 25, "searchString": "string", "sortField": "string", "sortOrder": "ASC" }

Responses

OK

Bodyapplication/json
dataArray of objects(ApSnmpAgentProfileApData)
pageinteger(int32)
totalCountinteger(int64)
totalPagesinteger(int32)
Response
application/json
{ "data": [ {} ], "page": 0, "totalCount": 0, "totalPages": 0 }

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

AP Venue

Manage Wi-Fi venue configuration, including radio settings, mesh, LEDs, LAN-ports, and syslog.

Operations

L2ACL Policy

Manage layer-2 ACL policy profiles.

Operations

Device Policy

Manage device policies.

Operations

MDNS Proxy Service Profile

Manage Multicast DNS proxy service profiles.

Operations

Access Control Profile

Manage access control profiles.

Operations

VLAN Pool

Manage VLAN pool profiles.

Operations

Recovery

Retrieve and set the recovery PSK.

Operations