Skip to content
/
Get External WISPr Provid...

Wi-Fi API and Model Documentation (17.3.3.144)

https://support.ruckuswireless.com/ruckus-cloud-wifi-legal-terms-and-conditions

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
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Asian region

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

European region

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

North American region

https://api.ruckus.cloud/

VLAN Pool Profile

Manage VLAN pool profiles.

Operations

LBS Server Profile

Manage location based service server profiles.

Operations

AP Compatibility

Query AP Feature compatibility report, including incompatible feature of AP model and firmware version.

Operations

Client Isolation Profile

Manage client isolation profiles.

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 profile 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 profile.

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 profiles 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 profile. If either of these situations applies in your network, please contact Ruckus customer support for assistance.

Operations

Wi-Fi Portal Service Profile

Portal service profile.

Operations

Application Library

Manage the current tenant's application library and settings.

Operations

SAML Identity Provider Profile

Manage SAML identity provider profiles.

Operations

Wi-Fi Calling Service Profile

Manage Wi-Fi calling service profiles.

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

Deactivate Wi-Fi Network On Venue

Request

Use this API to delete a relationship between Wi-Fi network and venue.

Path
venueIdstringrequired

Venue ID

wifiNetworkIdstringrequired

Wi-Fi Network ID

No request payload

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Activate Wi-Fi Network On Venue

Request

Use this API to build a relationship between Wi-Fi network and venue.

Path
venueIdstringrequired

Venue ID

wifiNetworkIdstringrequired

Wi-Fi Network ID

Body
isAllApGroupsboolean
Default true
{
  "isAllApGroups": true
}

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Get Venue Wi-Fi Network Settings

Request

Get Wi-Fi network settings on this venue.

Path
venueIdstringrequired

Venue ID

wifiNetworkIdstringrequired

Wi-Fi Network ID

No request payload

Responses

OK

Body
allApGroupsRadioTypesArray of strings
Items Enum"2.4-GHz""5-GHz""6-GHz"
allApGroupsVlanIdinteger(int32)[ 1 .. 4094 ]
isAllApGroupsboolean
Default true
schedulerobject(NetworkVenueScheduler)

Network-Venue scheduler

Response
{
  "allApGroupsRadioTypes": [
    "2.4-GHz"
  ],
  "allApGroupsVlanId": 1,
  "isAllApGroups": true,
  "scheduler": {
    "fri": "string",
    "mon": "string",
    "sat": "string",
    "sun": "string",
    "thu": "string",
    "tue": "string",
    "type": "ALWAYS_ON",
    "wed": "string"
  }
}

Update Venue Wi-Fi Network Settings

Request

Update Wi-Fi network settings on this venue.

Path
venueIdstringrequired

Venue ID

wifiNetworkIdstringrequired

Wi-Fi Network ID

Body
required
allApGroupsRadioTypesArray of strings
Items Enum"2.4-GHz""5-GHz""6-GHz"
allApGroupsVlanIdinteger(int32)[ 1 .. 4094 ]
isAllApGroupsboolean
Default true
schedulerobject(NetworkVenueScheduler)

Network-Venue scheduler

{
  "allApGroupsRadioTypes": [
    "2.4-GHz"
  ],
  "allApGroupsVlanId": 1,
  "isAllApGroups": true,
  "scheduler": {
    "fri": "string",
    "mon": "string",
    "sat": "string",
    "sun": "string",
    "thu": "string",
    "tue": "string",
    "type": "ALWAYS_ON",
    "wed": "string"
  }
}

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Create Wi-Fi Network

Request

Create a new Wi-Fi network.

Body
required
One of:

AAA Wi-Fi network

namestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
typestringrequired
descriptionstring[ 0 .. 256 ] characters
useCertificateTemplateboolean
Default false
wlanobject(AAAWifiWlan)required

AAA Wi-Fi WLAN

wlan.​advancedCustomizationobject(AAAWifiWlanAdvancedCustomization)

WLAN advanced customization

wlan.​bypassCNAboolean
Default false
wlan.​bypassCPUsingMacAddressAuthenticationboolean
Default false
wlan.​enabledboolean
Default true
wlan.​managementFrameProtectionstring
Enum"Disabled""Optional""Required"
wlan.​ssidstring[^`\s]([^`\t\r\n]){0,30}[^`\s]required
wlan.​vlanIdinteger(int32)[ 1 .. 4094 ]
Default 1
wlan.​wlanSecuritystring
Default "AAAWlanSecurityEnum.WPA2Enterprise"
Enum"WPA2Enterprise""WPA3"
{
  "name": "string",
  "type": "string",
  "description": "string",
  "useCertificateTemplate": false,
  "wlan": {
    "advancedCustomization": { … },
    "bypassCNA": false,
    "bypassCPUsingMacAddressAuthentication": false,
    "enabled": true,
    "managementFrameProtection": "Disabled",
    "ssid": "string",
    "vlanId": 1,
    "wlanSecurity": "WPA2Enterprise"
  }
}

Responses

Accepted

Body
requestIdstring
responseobject(EntityId)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Get Predefined Hotspot 2.0 Identity Providers

Request

Get predefined Hotspot 2.0 identity providers.

No request payload

Responses

OK

Body
Array [
idstring
namestring
]
Response
[
  {
    "id": "string",
    "name": "string"
  }
]

Get Predefined Hotspot 2.0 Operators

Request

Get predefined Hotspot 2.0 operators.

No request payload

Responses

OK

Body
Array [
idstring
namestring
]
Response
[
  {
    "id": "string",
    "name": "string"
  }
]

Get Default Options for QoS Map Set

Request

Get default options for QoS map set.

No request payload

Responses

OK

Body
rulesArray of objects(QosMapRule)[ 0 .. 8 ] items
Response
{
  "rules": [
    { … }
  ]
}

Get Wi-Fi Recovery Network Passphrase Settings

Request

Get the passphrase settings for the Wi-Fi recovery network.

No request payload

Responses

OK

Body
passphrasestring^([0-9]{4}){4}$
Response
{
  "passphrase": "string"
}

Update Wi-Fi Recovery Network Passphrase Settings

Request

Update the passphrase settings for the Wi-Fi recovery network.

Body
required
passphrasestring^([0-9]{4}){4}$
{
  "passphrase": "string"
}

Responses

Accepted

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

Get External WISPr Providers

Request

Get the list of external WISPr providers for a captive portal network. Note: these providers have integrated their service with the RUCKUS cloud.

No request payload

Responses

OK

Body
wisprProvidersArray of objects(WisprProvidersModel)
Response
{
  "wisprProviders": [
    { … }
  ]
}

Delete Wi-Fi Network

Request

Delete a Wi-Fi network.

Path
wifiNetworkIdstringrequired

Wi-Fi Network ID

No request payload

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Get Wi-Fi Network

Request

Get the Wi-Fi network details.

Path
wifiNetworkIdstringrequired

Wi-Fi Network ID

No request payload

Responses

OK

Body
idstringread-only
namestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
typestringrequired
Discriminator
descriptionstring[ 0 .. 256 ] characters
useCertificateTemplateboolean
Default false
wlanobject(AAAWifiWlan)required

AAA Wi-Fi WLAN

wlan.​advancedCustomizationobject(AAAWifiWlanAdvancedCustomization)

WLAN advanced customization

wlan.​bypassCNAboolean
Default false
wlan.​bypassCPUsingMacAddressAuthenticationboolean
Default false
wlan.​enabledboolean
Default true
wlan.​managementFrameProtectionstring
Enum"Disabled""Optional""Required"
wlan.​ssidstring[^`\s]([^`\t\r\n]){0,30}[^`\s]required
wlan.​vlanIdinteger(int32)[ 1 .. 4094 ]
Default 1
wlan.​wlanSecuritystring
Default "AAAWlanSecurityEnum.WPA2Enterprise"
Enum"WPA2Enterprise""WPA3"
Response
{
  "id": "string",
  "name": "string",
  "type": "AAAWifiNetwork",
  "description": "string",
  "useCertificateTemplate": false,
  "wlan": {
    "advancedCustomization": { … },
    "bypassCNA": false,
    "bypassCPUsingMacAddressAuthentication": false,
    "enabled": true,
    "managementFrameProtection": "Disabled",
    "ssid": "string",
    "vlanId": 1,
    "wlanSecurity": "WPA2Enterprise"
  }
}

Update Wi-Fi Network

Request

Update this Wi-Fi network, including nested details.

Path
wifiNetworkIdstringrequired

Wi-Fi Network ID

Body
required
One of:

AAA Wi-Fi network

namestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
typestringrequired
descriptionstring[ 0 .. 256 ] characters
useCertificateTemplateboolean
Default false
wlanobject(AAAWifiWlan)required

AAA Wi-Fi WLAN

wlan.​advancedCustomizationobject(AAAWifiWlanAdvancedCustomization)

WLAN advanced customization

wlan.​bypassCNAboolean
Default false
wlan.​bypassCPUsingMacAddressAuthenticationboolean
Default false
wlan.​enabledboolean
Default true
wlan.​managementFrameProtectionstring
Enum"Disabled""Optional""Required"
wlan.​ssidstring[^`\s]([^`\t\r\n]){0,30}[^`\s]required
wlan.​vlanIdinteger(int32)[ 1 .. 4094 ]
Default 1
wlan.​wlanSecuritystring
Default "AAAWlanSecurityEnum.WPA2Enterprise"
Enum"WPA2Enterprise""WPA3"
{
  "name": "string",
  "type": "string",
  "description": "string",
  "useCertificateTemplate": false,
  "wlan": {
    "advancedCustomization": { … },
    "bypassCNA": false,
    "bypassCPUsingMacAddressAuthentication": false,
    "enabled": true,
    "managementFrameProtection": "Disabled",
    "ssid": "string",
    "vlanId": 1,
    "wlanSecurity": "WPA2Enterprise"
  }
}

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

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

MAC Registration Pool

Manage MAC registration pool profiles.

Operations

Hotspot 2.0 Operator

Manage Hotspot 2.0 Operators.

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

AP Venue

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

Operations

Tunnel Service Profile

Manage tunnel service profiles.

Operations

L2ACL Policy

Manage layer-2 ACL policy profiles.

Operations

Ethernet Port Profile

Manage ethernet port profiles.

Operations

SNMP Agent Profile

Manage SNMP agent profiles.

Operations

Device Policy

Manage device policies.

Operations

Hotspot 2.0 Identity Provider

Manage Hotspot 2.0 Identity Providers.

Operations

MDNS Proxy Service Profile

Manage Multicast DNS proxy service profiles.

Operations

SoftGRE Profile

Manage SoftGRE profiles.

Operations

Access Control Profile

Manage access control profiles.

Operations

Certificate Template Activation

Manage certificate templates.

Operations

DPSK Service

Manage DPSK services.

Operations