Skip to content
/
Get DHCP Pools Usage in V...

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

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

Create DHCP Configuration Service Profile

Request

Create a new DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Body
required
dhcpModestring
Default "DhcpModeEnum.EnableOnEachAPs"
Enum"EnableOnEachAPs""EnableOnMultipleAPs""EnableOnHierarchicalAPs"
dhcpPoolsArray of objects(DhcpPool)[ 1 .. 4 ] itemsrequired
dhcpPools[].​descriptionstring[ 0 .. 255 ] characters
dhcpPools[].​endIpAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​leaseTimeHoursinteger(int32)[ 0 .. 24 ]required
dhcpPools[].​leaseTimeMinutesinteger(int32)[ 0 .. 59 ]required
dhcpPools[].​namestring[ 2 .. 32 ] characters^[!-~]([ -~])*[!-~]$required
dhcpPools[].​primaryDnsIpstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
dhcpPools[].​secondaryDnsIpstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
dhcpPools[].​startIpAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​subnetAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​subnetMaskstring^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...required
dhcpPools[].​vlanIdinteger(int32)[ 1 .. 4094 ]required
serviceNamestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
{
  "dhcpMode": "EnableOnEachAPs",
  "dhcpPools": [
    { … }
  ],
  "serviceName": "string"
}

Responses

Accepted

Body
requestIdstring
responseobject(DhcpConfigServiceProfileDeep)

DHCP service profile configuration

Response
{
  "requestId": "string",
  "response": {
    "dhcpMode": "EnableOnEachAPs",
    "dhcpPools": [ … ],
    "id": "string",
    "serviceName": "string",
    "usage": [ … ],
    "venueIds": [ … ]
  }
}

Delete DHCP Configuration Service Profile

Request

Delete a DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Path
dhcpConfigServiceProfileIdstringrequired

DHCP Config Service Profile ID

No request payload

Responses

Accepted

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

Get DHCP Configuration Service Profile

Request

Get the DHCP configuration service profile details. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Path
dhcpConfigServiceProfileIdstringrequired

DHCP Config Service Profile ID

No request payload

Responses

OK

Body
dhcpModestring
Default "DhcpModeEnum.EnableOnEachAPs"
Enum"EnableOnEachAPs""EnableOnMultipleAPs""EnableOnHierarchicalAPs"
dhcpPoolsArray of objects(DhcpPool)[ 1 .. 4 ] itemsrequired
dhcpPools[].​descriptionstring[ 0 .. 255 ] characters
dhcpPools[].​endIpAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​idstringread-only
dhcpPools[].​leaseTimeHoursinteger(int32)[ 0 .. 24 ]required
dhcpPools[].​leaseTimeMinutesinteger(int32)[ 0 .. 59 ]required
dhcpPools[].​namestring[ 2 .. 32 ] characters^[!-~]([ -~])*[!-~]$required
dhcpPools[].​primaryDnsIpstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
dhcpPools[].​secondaryDnsIpstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
dhcpPools[].​startIpAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​subnetAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​subnetMaskstring^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...required
dhcpPools[].​vlanIdinteger(int32)[ 1 .. 4094 ]required
idstringread-only
serviceNamestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
usageArray of objects(DhcpPoolVenueUsage)read-only
venueIdsArray of stringsread-only
Response
{
  "dhcpMode": "EnableOnEachAPs",
  "dhcpPools": [
    { … }
  ],
  "id": "string",
  "serviceName": "string",
  "usage": [
    { … }
  ],
  "venueIds": [
    "string"
  ]
}

Update DHCP Configuration Service Profile

Request

Update a DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Path
dhcpConfigServiceProfileIdstringrequired

DHCP Config Service Profile ID

Body
required
dhcpModestring
Default "DhcpModeEnum.EnableOnEachAPs"
Enum"EnableOnEachAPs""EnableOnMultipleAPs""EnableOnHierarchicalAPs"
dhcpPoolsArray of objects(DhcpPool)[ 1 .. 4 ] itemsrequired
dhcpPools[].​descriptionstring[ 0 .. 255 ] characters
dhcpPools[].​endIpAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​leaseTimeHoursinteger(int32)[ 0 .. 24 ]required
dhcpPools[].​leaseTimeMinutesinteger(int32)[ 0 .. 59 ]required
dhcpPools[].​namestring[ 2 .. 32 ] characters^[!-~]([ -~])*[!-~]$required
dhcpPools[].​primaryDnsIpstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
dhcpPools[].​secondaryDnsIpstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
dhcpPools[].​startIpAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​subnetAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...required
dhcpPools[].​subnetMaskstring^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...required
dhcpPools[].​vlanIdinteger(int32)[ 1 .. 4094 ]required
serviceNamestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
{
  "dhcpMode": "EnableOnEachAPs",
  "dhcpPools": [
    { … }
  ],
  "serviceName": "string"
}

Responses

Accepted

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

Get AP DHCP Client Leases

Request

Get a list of DHCP client leases of the AP.

Path
venueIdstringrequired

Venue ID

serialNumberstringrequired

The serial number of the AP.

No request payload

Responses

OK

Body
wifiDhcpClientLeasesArray of objects(WifiDhcpClientLease)
Response
{
  "wifiDhcpClientLeases": [
    { … }
  ]
}

Get DHCP Pools Usage in This AP

Request

Get DHCP pools usage in this AP.

Path
venueIdstringrequired

Venue ID

serialNumberstringrequired

The serial number of the AP.

No request payload

Responses

OK

Body
wifiDhcpPoolUsagesArray of objects(WifiDhcpPoolUsage)
Response
{
  "wifiDhcpPoolUsages": [
    { … }
  ]
}

Deactivate DHCP Configuration Service Profile On This Venue

Request

Deactivate DHCP configuration service profile on this venue.

Path
venueIdstringrequired

Venue ID

dhcpConfigServiceProfileIdstringrequired

DHCP Config Service Profile ID

No request payload

Responses

Accepted

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

Get DHCP Service Profile Settings of This Venue

Request

Get DHCP service profile settings of this venue.

Path
venueIdstringrequired

Venue ID

dhcpConfigServiceProfileIdstringrequired

DHCP Config Service Profile ID

No request payload

Responses

OK

Body
activeDhcpPoolNamesArray of strings
dhcpServiceApsArray of objects(DhcpServiceAp)
wanPortSelectionModestring
Default "DhcpWanPortSelectionModeEnum.Dynamic"
Enum"Dynamic""Manual"
Response
{
  "activeDhcpPoolNames": [
    "string"
  ],
  "dhcpServiceAps": [
    { … }
  ],
  "wanPortSelectionMode": "Dynamic"
}

Activate DHCP Configuration Service Profile On This Venue and Update Settings

Request

Activate DHCP configuration service profile on this venue and update settings.

Path
venueIdstringrequired

Venue ID

dhcpConfigServiceProfileIdstringrequired

DHCP Config Service Profile ID

Body
required
activeDhcpPoolNamesArray of strings
dhcpServiceApsArray of objects(DhcpServiceAp)
wanPortSelectionModestring
Default "DhcpWanPortSelectionModeEnum.Dynamic"
Enum"Dynamic""Manual"
{
  "activeDhcpPoolNames": [
    "string"
  ],
  "dhcpServiceAps": [
    { … }
  ],
  "wanPortSelectionMode": "Dynamic"
}

Responses

Accepted

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

Get Venue DHCP Leases

Request

Get a list of DHCP leases of the venue.

Path
venueIdstringrequired

Venue ID

No request payload

Responses

OK

Body
wifiDhcpClientLeasesArray of objects(WifiDhcpClientLease)
Response
{
  "wifiDhcpClientLeases": [
    { … }
  ]
}

Get DHCP Pools Usage in Venue

Request

Get DHCP pools usage in this venue.

Path
venueIdstringrequired

Venue ID

No request payload

Responses

OK

Body
wifiDhcpPoolUsagesArray of objects(WifiDhcpPoolUsage)
Response
{
  "wifiDhcpPoolUsages": [
    { … }
  ]
}

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