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

Add VLAN

Request

Create a VLAN of the switch profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
Body
required
idstring

Unique identifier for the VLAN configuration.

vlanIdinteger(int32)[ 1 .. 4095 ]required

VLAN identifier number (1-4095).

vlanNamestring

VLAN name for identification and management purposes.

rootBridgeFamilyIdstring

Root bridge family ID for spanning tree protocol.

Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean

Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).

ipv4DhcpSnoopingTrustPortstring

Comma separated list of trusted port identifiers for DHCP snooping.

ipv4DhcpSnoopingTrustPortListArray of strings

List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.

ipv6DhcpSnoopingboolean

Enable IPv6 DHCP Snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).

arpInspectionboolean

Enable ARP inspection to prevent ARP spoofing attacks (default: false).

ipv6NdInspectionboolean

Enable IPv6 neighbor discovery (ND) inspection to prevents IPv6 address spoofing at the switch level (default: false).

arpInspectionTrustPortstring

Comma separated list of trusted port identifiers for ARP inspection.

arpInspectionTrustPortListArray of strings

List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.

arpTrustPortsListArray of strings

List of ARP trusted ports for internal use.

dhcpTrustPortsListArray of strings

List of DHCP trusted ports for internal use.

igmpSnoopingstring

IGMP snooping mode for multicast traffic optimization.

Enum"active""passive""none"
multicastVersioninteger(int32)[ 0 .. 3 ]

IGMP multicast version (0-3).

spanningTreeProtocolstring

Spanning Tree Protocol mode for loop prevention (NONE, STP, RSTP, MSTP, PVST, default: NONE).

Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)[ 0 .. 65535 ]

Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).

switchFamilyModelsArray of objects(SwitchFamilyModelBo)unique

Set of switch family model configurations for this VLAN.

managementVlanboolean

Flag indicating whether this is a management VLAN for switch management access (default: false).

switchVlanPortModelsArray of objects(SwitchVlanPortModelBo)unique

Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.

switchIdstring

Switch identifier (serial number) where this VLAN is configured.

enableAsDefaultVlanbooleanrequired

Flag to enable this VLAN as the default VLAN for the switch (default: false).

{
  "id": "string",
  "vlanId": 1,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "ipv4DhcpSnoopingTrustPortList": [
    "string"
  ],
  "ipv6DhcpSnooping": true,
  "arpInspection": true,
  "ipv6NdInspection": true,
  "arpInspectionTrustPort": "string",
  "arpInspectionTrustPortList": [
    "string"
  ],
  "arpTrustPortsList": [
    "string"
  ],
  "dhcpTrustPortsList": [
    "string"
  ],
  "igmpSnooping": "active",
  "multicastVersion": 3,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 65535,
  "switchFamilyModels": [
    { … }
  ],
  "managementVlan": true,
  "switchVlanPortModels": [
    { … }
  ],
  "switchId": "string",
  "enableAsDefaultVlan": true
}

Responses

OK

Body
idstring

The identifier

vlanIdinteger(int32)

The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.

vlanNamestring

The descriptive name assigned to this VLAN for identification purposes.

rootBridgeFamilyIdstring

The switch family identifier for the root bridge in spanning tree topology.

Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean

The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.

ipv4DhcpSnoopingTrustPortstring

The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.

arpInspectionboolean

The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.

arpInspectionTrustPortstring

The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.

igmpSnoopingstring

The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.

Enum"active""passive""none"
multicastVersioninteger(int32)

The IGMP version number used for multicast group management in this VLAN.

spanningTreeProtocolstring

The Spanning Tree Protocol variant enabled for this VLAN: STP, RSTP, or MSTP.

Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)

The Spanning Tree Protocol bridge priority value for this VLAN, used in root bridge election.

switchFamilyModelsArray of objects(SwitchFamilyModel_V1)unique

The set of switch family models with specific configurations for this VLAN across different hardware types.

Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 0,
  "switchFamilyModels": [
    { … }
  ]
}

Retrieve VLANs

Request

List all usable VLANs for multiple ports of the same switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

OK

Body
switchDefaultVlanArray of objects(VlanIntersectContent)

The list of switch default VLAN configurations, representing the native VLAN settings on switches.

profileVlanArray of objects(VlanIntersectContent)

The list of VLAN configurations defined in port profiles.

switchVlanArray of objects(VlanIntersectContent)

The list of VLAN configurations directly assigned to switches.

Response
{
  "switchDefaultVlan": [
    { … }
  ],
  "profileVlan": [
    { … }
  ],
  "switchVlan": [
    { … }
  ]
}

Get VLANs

Request

Get a list of VLANs in profiles with the specified venue.

Security
jwtAuth
Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

vlanIdinteger(int32)

The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.

vlanNamestring

The descriptive name assigned to this VLAN for identification purposes.

rootBridgeFamilyIdstring

The switch family identifier for the root bridge in spanning tree topology.

Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean

The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.

ipv4DhcpSnoopingTrustPortstring

The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.

arpInspectionboolean

The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.

arpInspectionTrustPortstring

The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.

igmpSnoopingstring

The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.

Enum"active""passive""none"
multicastVersioninteger(int32)

The IGMP version number used for multicast group management in this VLAN.

spanningTreeProtocolstring

The Spanning Tree Protocol variant enabled for this VLAN: STP, RSTP, or MSTP.

Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)

The Spanning Tree Protocol bridge priority value for this VLAN, used in root bridge election.

switchFamilyModelsArray of objects(SwitchFamilyModel_V1)unique

The set of switch family models with specific configurations for this VLAN across different hardware types.

Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 0,
  "switchFamilyModels": [
    { … }
  ]
}

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