APIs published in this document are subject to strict change control by RUCKUS. As far as possible, when new versions of the Public API are published, all documented API endpoints will maintain backward compatibility. When not possible, an API endpoint will be deprecated and a replacement API or some other workaround will be provided. Support for deprecated API endpoints will continue for at least six months prior to removal in order to provide API client developers sufficient time to adopt the replacement. This document will indicate when API endpoints are deprecated along with the schedule for their removal. API client developers may discover other experimental API endpoints provided by the RUCKUS cloud, not included in this API document. RUCKUS reserves the right to change these experimental APIs without notice to API client developers.

RUCKUS Cloud API Documents

This document, Wi-Fi APIs and Model Documentation, is one of four documents describing the RUCKUS Cloud public API. Different API endpoints are described in each of the four documents, which are arranged according to the resources managed. Corresponding to each of the 4 HTML documents is an Open API v3 JSON document, which can be used to generate code for API clients.

Document Name	Resources Managed
wifi-ns-220711.html	Wi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks.
msp-ns-220711.html	MSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks.
platform-ns-220711.html	Platform related resources. This document describes API endpoints related to your account including administrators and their notification preferences, venues and your entitlements/licenses.
switch-ns-220711.html	ICX switch related resources. This document describes API endpoints related to managing your switches and wired networks.

Cloud Hosts

Region	Domain
Asia	https://asia.ruckus.cloud
Europe	https://eu.ruckus.cloud
North America	https://ruckus.cloud

Deprecated API Endpoints

API clients may continue to use deprecated API endpoints for up to 6 months after the release was made generally available (GA). After that, official support for these deprecated endpoints concludes and they may be removed by RUCKUS at any time thereafter without further notice.

Release v21.06.11

The following endpoints were deprecated in release v21.06.11. The new (replacement) URL should be used instead.

Deprecated URL	Replacement URL
/api/tenant/{tenantId}/wifi/ap/{serialNumber}/dhcp	/api/tenant/{tenantId}/wifi/ap/{serialNumber}/dhcp/usage

Non-Backward Compatible Changes to Wi-Fi APIs

One of the new features in RUCKUS cloud version 21.04.12 is improved integration of Cloudpath services. As of v21.04.12, it’s possible to use Cloudpath AAA services for 802.1X, DPSK, Guest and Open (MAC address authentication) WLANs. Support for client-device onboarding using Cloudpath enrollment services was retained.

However, in making these changes, support for the API schema objects “CloudpathNetwork”, “CloudpathNetworkDeep”, “CloudpathPortal” and “HotspotWlan” was removed. As of v21.04.12, API clients using these objects will no longer work. Management of Cloudpath services is provided by the “Cloudpath” API group. Refer to this group’s description below for further information.

Introduction to Wi-Fi Workflows

As an introduction to the Wi-Fi API endpoints, a basic workflow to install and configure a Wi-Fi network is described. The order of steps described below is merely an example. The description below is not meant to be comprehensive; rather, it’s meant to be a guide to get you started with API client development.

1. Create a venue for your APs. The API group for creating venues is described in the Platform API document, in the “Venue” API group. You can create as many venues as you like. Typically, one venue is created for each building in which you install APs. Or you can also use just one “venue” for all the buildings on a campus; alternatively, a “venue” might be just a single floor in a multi-story building or an outdoor park.
2. Provision your APs. To provision an AP, add the AP using the “Add APs“ endpoint in the AP API group. Once your APs are provisioned, physically install them. They will automatically contact and join the RUCKUS cloud. You can physically install your APs prior to provisioning, but they won’t join the cloud until provisioned. In order to install an AP, your account must possess activated licenses. Purchased licenses are activated on the RUCKUS support website. Use endpoints in the entitlement API group (cf. Platform API documentation) to manage your entitlements (aka licenses). If you don’t have any activated entitlements, the “Add APs“ endpoint will return an error response.
3. Verify your APs have connected to the cloud. To check an AP’s connection, use the “Get APs“ endpoint in the AP API group. The API response provides the AP’s connection status. If your APs are having trouble connecting, you can locally log into your AP and use its troubleshooting utilities to diagnose the problem.
4. Create a WLAN. Use the endpoints in the “Network” API group to create a WLAN. Note that WLANs are global resources that can be activated in as many venues as you like. Simply creating a WLAN does not deploy it to APs. To deploy the WLAN, it must be “activated” on a venue. Use the endpoints in the “Network-Venue” API group for managing WLAN deployments.
5. Customize the configuration of your APs. AP configuration can be customized on three different levels.
   • All the APs in a venue can be collectively customized using endpoints in the “AP-Venue” API group. On a per-venue basis, you can customize the radio or LAN-port settings of your APs as well as enable and manage mesh networking.
   • APs can be grouped together using endpoints in the “AP Group” API group. Each venue can have one or more AP groups; if you don’t explicitly configure AP groups, all APs in a venue are members of the “default” group. Grouping APs is typically done to restrict the deployment of certain WLANs to the APs in a group rather than all the APs in a venue. You might want to do this, for example, to only enable your guest WLAN in the lobby of your venue. Also, using AP groups, WLANs can be enabled on either the 2.4-GHz or 5-GHz band instead of both bands (which is the default). Use the endpoints in the “Network-Venue” API group for managing WLAN (network) assignments to AP Groups.
   • APs can be individually customized using endpoints in the “AP” API group. On a per-AP basis, you can customize an AP’s radio or LAN-port settings. Individual AP configuration override group-level and venue-level configuration.
6. Protect your network. Enable rogue AP detection, configure rogue AP classification policies and view reports on detected rogue APs. Use the endpoints in the “AP-Venue” API group for this purpose. Note: once an administrator is informed of the presence of a rogue AP, he/she can take steps to manually remove it.
7. Add sophistication to your WLAN. Use the endpoints in the “L2AclPolicy”, “L3AclPolicy”, “Device Policy”, and “Application Policy” API groups to create and manage WLAN policies that manage your wireless clients (end-user devices) and their connections to online services more effectively.
8. Add new services to your wireless network. Services such as Wi-Fi calling, location (aka vSPoT) are available; they can be configured and managed using the endpoints in their respective API groups. APs can provide DHCP service with sufficient scale for small offices or branch offices - use the endpoints in “DHCP Service Profile” API group to configure the service and endpoints in “DHCP Service Profile Venue” to activate them on your venues.
9. Manage your network’s client devices. If you have a guest WLAN which uses guest passes, you can create and manage guest users with endpoints in the “Guest User“ API group. If you find client devices which should not be on your network, you can disconnect them using an endpoint in the “Client Disconnect“ API group.