Skip to content

Switch Service API & Model Documentation (0.3.4)

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
Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.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

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Get Switch VLAN

Request

Get the specified switch-level VLAN by id.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
vlanIdstringrequired
No request payload

Responses

OK

Body
idstring
vlanIdinteger(int32)
vlanNamestring
ipv4DhcpSnoopingboolean
arpInspectionboolean
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)
spanningTreeProtocolstring
Enum"rstp""stp""none"
taggedPortsstring
untaggedPortsstring
switchVlanPortModelsArray of objects(SwitchVlanPortModelViewV1001)unique
enableAsDefaultVlanboolean
usedByVePortboolean
isAuthDefaultVlanboolean
isAuthVlanboolean
Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "ipv4DhcpSnooping": true,
  "arpInspection": true,
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "taggedPorts": "string",
  "untaggedPorts": "string",
  "switchVlanPortModels": [
    { … }
  ],
  "enableAsDefaultVlan": true,
  "usedByVePort": true,
  "isAuthDefaultVlan": true,
  "isAuthVlan": true
}

Update Switch VLAN

Request

Update a VLAN of the switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
vlanIdstringrequired
Body
required
idstring
vlanIdinteger(int32)[ 1 .. 4095 ]
vlanNamestring
ipv4DhcpSnoopingboolean
arpInspectionboolean
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)[ 0 .. 3 ]
spanningTreeProtocolstring
Enum"rstp""stp""none"
switchVlanPortModelsArray of objects(SwitchVlanPortModelViewV1001)unique
enableAsDefaultVlanboolean
{
  "id": "string",
  "vlanId": 1,
  "vlanName": "string",
  "ipv4DhcpSnooping": true,
  "arpInspection": true,
  "igmpSnooping": "active",
  "multicastVersion": 3,
  "spanningTreeProtocol": "rstp",
  "switchVlanPortModels": [
    { … }
  ],
  "enableAsDefaultVlan": true
}

Responses

OK

Body
requestIdstring
responseobject(SwitchVlanViewV1001)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "vlanId": 0,
    "vlanName": "string",
    "ipv4DhcpSnooping": true,
    "arpInspection": true,
    "igmpSnooping": "active",
    "multicastVersion": 0,
    "spanningTreeProtocol": "rstp",
    "taggedPorts": "string",
    "untaggedPorts": "string",
    "switchVlanPortModels": [ … ],
    "enableAsDefaultVlan": true,
    "usedByVePort": true,
    "isAuthDefaultVlan": true,
    "isAuthVlan": true
  }
}

Delete Switch VLAN

Request

Delete a VLAN of the switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
vlanIdstringrequired
No request payload

Responses

OK

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

Add Switch VLANs

Request

Create multiple VLANs under the specified switches.

Security
jwtAuth
Path
venueIdstringrequired
Body
requiredArray [
idstring
vlanIdinteger(int32)[ 1 .. 4095 ]
vlanNamestring
ipv4DhcpSnoopingboolean
arpInspectionboolean
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)[ 0 .. 3 ]
spanningTreeProtocolstring
Enum"rstp""stp""none"
switchVlanPortModelsArray of objects(SwitchVlanPortModelViewV1001)unique
enableAsDefaultVlanboolean
switchIdstringrequired
]
[
  {
    "id": "string",
    "vlanId": 1,
    "vlanName": "string",
    "ipv4DhcpSnooping": true,
    "arpInspection": true,
    "igmpSnooping": "active",
    "multicastVersion": 3,
    "spanningTreeProtocol": "rstp",
    "switchVlanPortModels": [ … ],
    "enableAsDefaultVlan": true,
    "switchId": "string"
  }
]

Responses

Created

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

Retrieve Switch VLANs

Request

Retrieve all usable VLANs under the specified switches.

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

Responses

OK

Body
Array [
switchIdstring
defaultVlanIdinteger(int32)
vlanListArray of objects(SwitchVlanViewV1001)
]
Response
[
  {
    "switchId": "string",
    "defaultVlanId": 0,
    "vlanList": [ … ]
  }
]

Get VLAN-VE-Ports

Request

List all usable VLANs that are available for the VE setting.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

OK

Body
idstring
vlanIdstring
vlanNamestring
usedByVePortboolean
Response
{
  "id": "string",
  "vlanId": "string",
  "vlanName": "string",
  "usedByVePort": true
}

Add Switch VLAN

Request

Create a VLAN of the switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
idstring
vlanIdinteger(int32)[ 1 .. 4095 ]
vlanNamestring
ipv4DhcpSnoopingboolean
arpInspectionboolean
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)[ 0 .. 3 ]
spanningTreeProtocolstring
Enum"rstp""stp""none"
switchVlanPortModelsArray of objects(SwitchVlanPortModelViewV1001)unique
enableAsDefaultVlanboolean
{
  "id": "string",
  "vlanId": 1,
  "vlanName": "string",
  "ipv4DhcpSnooping": true,
  "arpInspection": true,
  "igmpSnooping": "active",
  "multicastVersion": 3,
  "spanningTreeProtocol": "rstp",
  "switchVlanPortModels": [
    { … }
  ],
  "enableAsDefaultVlan": true
}

Responses

Created

Body
requestIdstring
responseobject(SwitchVlanViewV1001)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "vlanId": 0,
    "vlanName": "string",
    "ipv4DhcpSnooping": true,
    "arpInspection": true,
    "igmpSnooping": "active",
    "multicastVersion": 0,
    "spanningTreeProtocol": "rstp",
    "taggedPorts": "string",
    "untaggedPorts": "string",
    "switchVlanPortModels": [ … ],
    "enableAsDefaultVlan": true,
    "usedByVePort": true,
    "isAuthDefaultVlan": true,
    "isAuthVlan": true
  }
}

Delete Switch VLANs

Request

Delete multiple VLANs of the switch.

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

Responses

OK

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

Query Switch VLANs

Request

Query the switch's switch-level VLANs.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
filtersobject
searchStringstring
searchTargetFieldsArray of strings
filterTypestringDeprecated
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "filterType": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ]
}

Responses

OK

Body
idstring
dataArray of objects
fieldsArray of strings
pageinteger(int32)
totalCountinteger(int64)
totalPagesinteger(int32)
Response
{
  "id": "string",
  "data": [
    {}
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Get VLANs

Request

List all usable VLANs under this venue.

Security
jwtAuth
Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring
vlanIdinteger(int32)[ 1 .. 4095 ]
vlanConfigNamestring[ 0 .. 32 ] characters
Response
{
  "id": "string",
  "vlanId": 1,
  "vlanConfigName": "string"
}

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