View Model Resources (1.0.44)

Ruckus Network Technical Documents

Download OpenAPI description

Download PDF

Overview

License

RUCKUS Cloud Privacy Policy

Servers

RUCKUS One API host for North American region.

https://api.ruckus.cloud

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud

View Switch

View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Client Isolation Profiles

Manage client isolation profiles for tenant queries and policy visibility.

Operations

View VLAN Pool Profiles

Manage VLAN (Virtual Local Area Network) pool profiles for viewing and queries.

Operations

View SoftGRE Profile

Provides SoftGRE profile API operations for querying tenant configurations and results.

Operations

View Wi-Fi Profile

View Wi-Fi service and policy profile information including RADIUS authentication.

Operations

View Template

View template information using /rec/templates for REC templates when needed.

Operations

View Portal Service Profiles

Manage portal service profiles for tenant viewing and template queries.

Operations

View Venue Template

View venue template information using /rec/templates for REC templates when needed.

Operations

View Platform

View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Wi-Fi

View Wi-Fi information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

Network

Network API (Application Programming Interface) for tenant network queries and counts.

Operations

View Ethernet Port Profile

Ethernet port profile API (Application Programming Interface) for tenant queries and management.

Operations

Quality of Service

View Quality of Service (QoS) information for network performance insights.

Operations

View Venue Topology

View venue topology information for mesh and standard network layouts.

Operations

Get Mesh Topology

Request

Get venue mesh topology data focused on mesh links and devices.

Path

venueIdstringrequired

No request payload

Responses

Successful operation

Body

dataArray of objects(TopologyResponseDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Topology

Request

Get venue topology data for visualizing devices and mesh connections.

Path

venueIdstringrequired

Query

meshOnlybooleanrequired

Get mesh topology

No request payload

Responses

Successful operation

Body

dataArray of objects(TopologyResponseDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

View SNMP Agent Profiles

Manage SNMP (Simple Network Management Protocol) agent profiles for tenants.

Operations

View Venue

View venue information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Portal Service Template

View portal service template information using /rec/templates for REC templates when needed.

Operations

View Wi-Fi Template

View Wi-Fi template information using /rec/templates for REC templates when needed.

Operations

Client API

Client API (Application Programming Interface) for querying access point clients across venues.

Operations

Edge SD-LAN Status

Edge SD-LAN status API.

Operations

venue

Operations