RUCKUS Cloud - Platform APIs and Model Documentation (v20.11.11)

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.

Cloud hosts: North American region: "https://ruckus.cloud", European region: "https://eu.ruckus.cloud", Asian region: "https://asia.ruckus.cloud".

NOTE: After authenticating, all APIs require a Tenant ID.
Find your Tenant ID by logging-in to https://ruckus.cloud - your Tenant ID is the 32 character string in the URL after "https://ruckus.cloud/api/ui/t/".

Authentication

Token

Security Scheme Type OAuth2
password OAuth Flow
Token URL: https://ruckus.cloud/token
Scopes:
  • all -

    Grant access

Authentication

Authentication operations.

Request Authentication

Returns an authentication cookie, token and API-KEY.
Use the token to manually set a cookie if your client does not automatically support them.

Request Body schema: application/json

User's credential.

password
string
username
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "username": "string"
}

Access Sub-Account

This endpoint returns a token which can be used to access your customer's account (e.g., an MSP-EC).

path Parameters
tenantId
required
string

Tenant ID of the sub-account (e.g., MSP-EC) to which access is being requested.

Responses

Request

Most RUCKUS Cloud modification APIs are asynchronous. This will be indicated by a successful HTTP response status code of 202 "Accepted". In these cases, call the Request APIs to retrieve your asynchronous-request status to determine if it succeeded, failed or is still pending.

Get request list

path Parameters
status
required
string
Enum: "PENDING" "SUCCESS" "FAIL"

status

tenantId
required
string

tenantId

query Parameters
page
string

page

size
string

size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Request details

path Parameters
requestId
required
string

requestId

tenantId
required
string

tenantId