Skip to content

Switch Service API & Model Documentation (0.4.0)

Overview

Rate Limit

For the Switch REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 20 calls can be made per second.
  • Each second 10 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Terms of Service
Languages
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/

AAA Server

Manage AAA (authentication, authorization, and accounting) Servers.

Operations

AAA Setting

Manage AAA (authentication, authorization, and accounting) Settings.

Operations

Command Line Interface Template

Manage command line interface templates.

Operations

Configuration History

Retrieve configuration history.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX Switches.

Operations

Import Switch

Import Switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Get LAG

Request

Get LAG setting by id.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
lagIdstringrequired
No request payload

Responses

OK

Body
idstring
lagIdinteger(int32)

The unique identifier of the LAG interface.

namestring

The name of the LAG interface.

typestring

The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).

Enum"static""dynamic"
portsArray of stringsunique

The set of physical port identifiers that are members of this LAG.

taggedVlansArray of stringsunique

The set of VLAN identifiers that are tagged on this LAG interface.

untaggedVlanstring

The VLAN identifier for untagged traffic on this LAG interface.

forceUpPortstring

The port identifier to force into an up state within the LAG.

Response
{
  "id": "string",
  "lagId": 0,
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "forceUpPort": "string"
}

Update LAG

Request

Update switch's LAG setting.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
lagIdstringrequired
Body
required
namestring

The name of the LAG interface.

typestring

The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).

Enum"static""dynamic"
portsArray of stringsunique

The set of physical port identifiers that are members of this LAG.

taggedVlansArray of stringsunique

The set of VLAN identifiers that are tagged on this LAG interface.

untaggedVlanstring

The VLAN identifier for untagged traffic on this LAG interface.

forceUpPortstring

The port identifier to force into an up state within the LAG.

{
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "forceUpPort": "string"
}

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(Lag_V1_1)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "forceUpPort": "string"
  }
}

Delete LAG

Request

Delete switch's LAG setting.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
lagIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Get LAGs

Request

List of switch's LAG settings.

Security
jwtAuth
Path
switchIdstringrequired
venueIdstringrequired
No request payload

Responses

OK

Body
Array [
idstring
lagIdinteger(int32)

The unique identifier of the LAG interface.

namestring

The name of the LAG interface.

typestring

The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).

Enum"static""dynamic"
portsArray of stringsunique

The set of physical port identifiers that are members of this LAG.

taggedVlansArray of stringsunique

The set of VLAN identifiers that are tagged on this LAG interface.

untaggedVlanstring

The VLAN identifier for untagged traffic on this LAG interface.

forceUpPortstring

The port identifier to force into an up state within the LAG.

]
Response
[
  {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "forceUpPort": "string"
  }
]

Add LAGs

Request

Add switch's multiple LAG settings.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
requiredArray [
namestring

The name of the LAG interface.

typestring

The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).

Enum"static""dynamic"
portsArray of stringsunique

The set of physical port identifiers that are members of this LAG.

taggedVlansArray of stringsunique

The set of VLAN identifiers that are tagged on this LAG interface.

untaggedVlanstring

The VLAN identifier for untagged traffic on this LAG interface.

forceUpPortstring

The port identifier to force into an up state within the LAG.

]
[
  {
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "forceUpPort": "string"
  }
]

Responses

Created

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(Lag_V1_1)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "forceUpPort": "string"
  }
}

Delete LAGs

Request

Delete switch's multiple LAG settings.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
requiredArray [
string
]
[
  "string"
]

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Profile

Manage switch profiles.

Operations

Profile Template

Manage switch profile templates.

Operations

Profile VLAN

Manage VLANs (virtual local area networks) of switch profile.

Operations

Switch Access Control List

Manage ACLs (access control lists).

Operations

Switch Configuration Backup

Manage configuration backups.

Operations

Switch Firmware Upgrade

Manage firmware upgrade.

Operations

Switch Ports

Manage Ports.

Operations

Switch Static Routes

Manage static routes.

Operations

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Operations

Venue Switch Setting

Manage a switch's venue level settings.

Operations

Venue Template AAA Server

Manage Venue Template AAA (authentication, authorization, and accounting) Servers.

Operations

Venue Template AAA Setting

Manage Venue Template AAA (authentication, authorization, and accounting) Settings.

Operations

Venue Template Switch Setting

Manage switch settings of venue template.

Operations

Web Authentication Page Template

Manage web authentication page template.

Operations