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

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

Get Static Route

Request

Get the specified static route.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
staticRouteIdstringrequired
No request payload

Responses

OK

Body
idstring
destinationIpstring^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

The destination IP address and subnet mask in CIDR notation for the static route.

nextHopstring^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

The IP address of the next hop gateway to route traffic for the destination network.

adminDistanceinteger(int32)[ 1 .. 255 ]

The administrative distance value for route preference, with lower values having higher priority.

Response
{
  "id": "string",
  "destinationIp": "string",
  "nextHop": "string",
  "adminDistance": 1
}

Update Static Route

Request

Update the specified static route.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
staticRouteIdstringrequired
Body
required
idstring
destinationIpstring^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

The destination IP address and subnet mask in CIDR notation for the static route.

nextHopstring^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

The IP address of the next hop gateway to route traffic for the destination network.

adminDistanceinteger(int32)[ 1 .. 255 ]

The administrative distance value for route preference, with lower values having higher priority.

{
  "id": "string",
  "destinationIp": "string",
  "nextHop": "string",
  "adminDistance": 1
}

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(StaticRoute_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "destinationIp": "string",
    "nextHop": "string",
    "adminDistance": 1
  }
}

Delete Static Route

Request

Delete the specified static route.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
staticRouteIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Get Static Routes

Request

Get multiple static routes of the switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

OK

Body
Array [
idstring
destinationIpstring^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

The destination IP address and subnet mask in CIDR notation for the static route.

nextHopstring^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

The IP address of the next hop gateway to route traffic for the destination network.

adminDistanceinteger(int32)[ 1 .. 255 ]

The administrative distance value for route preference, with lower values having higher priority.

]
Response
[
  {
    "id": "string",
    "destinationIp": "string",
    "nextHop": "string",
    "adminDistance": 1
  }
]

Add Static Route

Request

Add multiple static routes of the switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
requiredArray [
idstring
destinationIpstring^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

The destination IP address and subnet mask in CIDR notation for the static route.

nextHopstring^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

The IP address of the next hop gateway to route traffic for the destination network.

adminDistanceinteger(int32)[ 1 .. 255 ]

The administrative distance value for route preference, with lower values having higher priority.

]
[
  {
    "id": "string",
    "destinationIp": "string",
    "nextHop": "string",
    "adminDistance": 1
  }
]

Responses

Created

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(StaticRoute_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "destinationIp": "string",
    "nextHop": "string",
    "adminDistance": 1
  }
}

Delete Static Routes

Request

Delete multiple static routes.

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

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

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