RUCKUS AI REST APIs

This document describes the RUCKUS AI public APIs. All RUCKUS AI APIs are hosted on the mapped subdomain, "api.".

RUCKUS AI API Hosts

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

To maintain system performance and prevent excessive API usage, rate limiting is enforced on certain API endpoints. Rate limiting controls the number of API requests an application or user can make within a specific time period. If this limit is exceeded, additional requests will be throttled, and the API will return an 'HTTP 429 Too Many Requests' response.

For more information, please refer to https://docs.ruckus.cloud/api.

Authenticating

The RUCKUS AI REST APIs use JSON Web Tokens (JWT) to secure all endpoints.

Ruckus AI authentication APIs are using the OAuth2 client credentials standard APIs, as described here: https://datatracker.ietf.org/doc/html. The API will authenticate a user client and will provide the JWT token.

How to Authenticate

Once logged into Ruckus AI, the Administrator must create an "Application Token" consisting of client ID and client secret, and can be found under Administration -> Developers -> Application Tokens.

The following endpoint will be used to authenticate and retrieve the JWT token:

Here is an example with curl:

    curl --request POST \
    --url 'https://auth.ruckus.cloud/oauth2/token' \
    --header 'content-type: application/x-www-form-urlencoded' \
    --data grant_type=client_credentials \
    --data client_id=<client id> \
    --data client_secret=<client secret>

Once you have acquired your JWT token, it must be included as "Authorization" HTTP request header of all subsequent requests. The format expected in the authentication header is "Bearer xxxxxxa". For additional information on the authentication scheme being used, please see RFC 6750 Section 2.1.

Using the API's in Delegated Mode

To access any REST API for a delegated account, correctly authenticate. Provide your JWT authentication credentials, but in addition, include the custom header with a key of "x-rks-tenantid" and value of tenant id to identify the delegated account.

Manage application tokens

Manage licenses

Manage onboarded systems

Manage resource groups

Manage users