License and Terms of Service

License: RUCKUS One Privacy Policy | Terms of Service

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 RUCKUS One not included in this API document. RUCKUS reserves the right to change these experimental APIs without notice to API client developers.

Existing RUCKUS Cloud API Users, please continue to use the current API domain hosts. The JWT changes will need to be made, and details on this and on breaking changes can be found at RUCKUS Cloud Required Changes and Migrating to RUCKUS One API's.

Asynchronous Workflows: In many cases, requests to create or change data is handled asynchronously. In these case the return value from the API call will be the requestId for the activity that was triggered to perform the request. The API consumer will need to:

  1. Read the "requestId" from the response
  2. Poll the activity service with the requestId and wait for SUCCESS using GET /api/tenant/{tenantId}/activity/{requestId}
  3. GET the list of resources to find the item created

RUCKUS One API Documents

This document describes the RUCKUS One public API. All RUCKUS One API's are hosted on the mapped subdomain, "api.". Different API endpoints, grouped by functionality, can be found in the navigation index. Corresponding to each of the functional items is an Open API v3 JSON document, which can be used to generate code for API clients.

Upcoming Changes

This section is a short list of the upcoming API changes and features.

  • API Rate Limiting: API's will start to enforce rate limiting. See the details below.
  • Adaptive Policies and Property Management are now available
  • API support for the identity feature in RUCKUS One.

    • Rate Limiting

    The Ruckus One API's have added rate limiting to several of the APIs. A rate limit is the number of API calls an app or user can make within a given time period. If this limit is exceeded, the app or user may be throttled. API requests made by a throttled user or app will fail. The API will return a 429 to indicate rate limiting has been encountered. Each set of APIs which have rate limiting will identify the limits for those APIs in the API information included with each API section. The rate limit is determined by three key aspects:

  • The "Key": For Ruckus ONE Core APIs the all rate limiting is per tenant.
  • How many calls are permitted per minute for each tenant.
  • How fast the number of calls allowed are restored. To prevent a flood of API requests, rate limiting only allows a fixed number of APIs calls to be restored after the limit is encountered.

    • RUCKUS One API Hosts

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