RUCKUS Cloud - Switch API 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".

IcxSwitch

Manage ICX Switches.

Get Switches

List of tenant's Switches

path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Switch

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

defaultGateway
string
description
string [ 0 .. 255 ] characters
enableStack
boolean

default: false

id
required
string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK...
igmpSnooping
string
Enum: "active" "passive" "none"
ipAddress
string
isPrimaryDeleted
boolean

default: false

jumboMode
boolean

default: false

name
string^(?:(?!").){1,255}$
object (SwitchPosition)

Switch Position object

softDeleted
boolean

default: false

softDeletedDate
string <date-time>
Array of objects (StackMembers)
subnetMask
string
tags
string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$...
venueId
required
string

Responses