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

Get ICX Switch

Request

Get ICX switch by id.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring

The name assigned to the ICX switch for identification in the network.

descriptionstring

The descriptive text providing additional information about the switch configuration or purpose.

enableStackboolean

The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.

igmpSnoopingstring

The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.

Enum"active""passive""none"
jumboModeboolean

The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.

spanningTreePriorityinteger(int32)

The Spanning Tree Protocol bridge priority value, used in root bridge election (lower values have higher priority).

StackMembers_V1_1Array of objects(StackMembers_V1_1)

The list of member switches in a stack configuration, including their models and active status.

ipAddressInterfaceTypestring

The interface type for the switch management IP address: VLAN interface or management port.

Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring

The specific interface identifier for the management IP address configuration.

ipAddressTypestring

The IP address assignment method: static or DHCP.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to the switch management interface.

subnetMaskstring

The subnet mask for the switch management IP address.

defaultGatewaystring

The default gateway IP address for routing traffic from the switch management interface.

dhcpClientEnabledboolean

The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.

dhcpServerEnabledboolean

The flag indicating whether the DHCP server feature is enabled on the switch.

initialVlanIdinteger(int32)

The VLAN ID used for initial switch configuration and management access.

specifiedTypestring

The firmware image type specified for the switch: primary, secondary, or boot.

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

The model identifier of the rear expansion module installed on the switch, if applicable.

vlanCustomizeboolean

The flag indicating whether VLAN configurations have been customized from default settings.

Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "spanningTreePriority": 0,
  "StackMembers_V1_1": [
    { … }
  ],
  "ipAddressInterfaceType": "NONE",
  "ipAddressInterface": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "subnetMask": "string",
  "defaultGateway": "string",
  "dhcpClientEnabled": true,
  "dhcpServerEnabled": true,
  "initialVlanId": 0,
  "specifiedType": "AUTO",
  "rearModule": "string",
  "vlanCustomize": true
}

Update ICX Switch

Request

Update ICX switch. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
idstring
namestring

The name assigned to the ICX switch for identification in the network.

descriptionstring

The descriptive text providing additional information about the switch configuration or purpose.

enableStackboolean

The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.

igmpSnoopingstring

The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.

Enum"active""passive""none"
jumboModeboolean

The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.

spanningTreePriorityinteger(int32)

The Spanning Tree Protocol bridge priority value, used in root bridge election (lower values have higher priority).

StackMembers_V1_1Array of objects(StackMembers_V1_1)

The list of member switches in a stack configuration, including their models and active status.

ipAddressInterfaceTypestring

The interface type for the switch management IP address: VLAN interface or management port.

Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring

The specific interface identifier for the management IP address configuration.

ipAddressTypestring

The IP address assignment method: static or DHCP.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to the switch management interface.

subnetMaskstring

The subnet mask for the switch management IP address.

defaultGatewaystring

The default gateway IP address for routing traffic from the switch management interface.

dhcpClientEnabledboolean

The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.

dhcpServerEnabledboolean

The flag indicating whether the DHCP server feature is enabled on the switch.

initialVlanIdinteger(int32)

The VLAN ID used for initial switch configuration and management access.

specifiedTypestring

The firmware image type specified for the switch: primary, secondary, or boot.

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

The model identifier of the rear expansion module installed on the switch, if applicable.

vlanCustomizeboolean

The flag indicating whether VLAN configurations have been customized from default settings.

{
  "id": "string",
  "name": "string",
  "description": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "spanningTreePriority": 0,
  "StackMembers_V1_1": [
    { … }
  ],
  "ipAddressInterfaceType": "NONE",
  "ipAddressInterface": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "subnetMask": "string",
  "defaultGateway": "string",
  "dhcpClientEnabled": true,
  "dhcpServerEnabled": true,
  "initialVlanId": 0,
  "specifiedType": "AUTO",
  "rearModule": "string",
  "vlanCustomize": true
}

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(IcxSwitch_V1_1)

The ICX switch view for API version 1_1, representing a comprehensive view of a Ruckus ICX switch with detailed hardware, software, and configuration information.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "enableStack": true,
    "igmpSnooping": "active",
    "jumboMode": true,
    "spanningTreePriority": 0,
    "StackMembers_V1_1": [ … ],
    "ipAddressInterfaceType": "NONE",
    "ipAddressInterface": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "subnetMask": "string",
    "defaultGateway": "string",
    "dhcpClientEnabled": true,
    "dhcpServerEnabled": true,
    "initialVlanId": 0,
    "specifiedType": "AUTO",
    "rearModule": "string",
    "vlanCustomize": true
  }
}

Add ICX Switch

Request

Add an ICX switch. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
idstring
namestring

The name assigned to the ICX switch for identification in the network.

descriptionstring

The descriptive text providing additional information about the switch configuration or purpose.

enableStackboolean

The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.

igmpSnoopingstring

The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.

Enum"active""passive""none"
jumboModeboolean

The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.

spanningTreePriorityinteger(int32)

The Spanning Tree Protocol bridge priority value, used in root bridge election (lower values have higher priority).

StackMembers_V1_1Array of objects(StackMembers_V1_1)

The list of member switches in a stack configuration, including their models and active status.

ipAddressInterfaceTypestring

The interface type for the switch management IP address: VLAN interface or management port.

Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring

The specific interface identifier for the management IP address configuration.

ipAddressTypestring

The IP address assignment method: static or DHCP.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to the switch management interface.

subnetMaskstring

The subnet mask for the switch management IP address.

defaultGatewaystring

The default gateway IP address for routing traffic from the switch management interface.

dhcpClientEnabledboolean

The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.

dhcpServerEnabledboolean

The flag indicating whether the DHCP server feature is enabled on the switch.

initialVlanIdinteger(int32)

The VLAN ID used for initial switch configuration and management access.

specifiedTypestring

The firmware image type specified for the switch: primary, secondary, or boot.

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

The model identifier of the rear expansion module installed on the switch, if applicable.

vlanCustomizeboolean

The flag indicating whether VLAN configurations have been customized from default settings.

{
  "id": "string",
  "name": "string",
  "description": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "spanningTreePriority": 0,
  "StackMembers_V1_1": [
    { … }
  ],
  "ipAddressInterfaceType": "NONE",
  "ipAddressInterface": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "subnetMask": "string",
  "defaultGateway": "string",
  "dhcpClientEnabled": true,
  "dhcpServerEnabled": true,
  "initialVlanId": 0,
  "specifiedType": "AUTO",
  "rearModule": "string",
  "vlanCustomize": true
}

Responses

Accepted

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"
  }
}

Delete ICX Switch

Request

Delete ICX switch by id.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

Accepted

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"
  }
}

Update Switch Position

Request

Update ICX switch position in the floor plan.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
floorPlanIdstring

The unique identifier of the floor plan where the switch is located.

xPercentnumber(float)

The horizontal position of the switch on the floor plan as a percentage of the total width, ranging from 0.0 to 100.0.

yPercentnumber(float)

The vertical position of the switch on the floor plan as a percentage of the total height, ranging from 0.0 to 100.0.

{
  "floorPlanId": "string",
  "xPercent": 0.1,
  "yPercent": 0.1
}

Responses

Accepted

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"
  }
}

Retrieve ICX Switches

Request

Retrieve list of venues' ICX switches.

Security
jwtAuth
Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

venueIdstring

The unique identifier of the venue where the switch is located.

namestring

The name assigned to the ICX switch for identification in the network.

descriptionstring

The descriptive text providing additional information about the switch configuration or purpose.

tagsstring

The comma separated list of custom tags assigned to this switch for organization and filtering.

enableStackboolean

The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.

igmpSnoopingstring

The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.

Enum"active""passive""none"
jumboModeboolean

The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.

positionobject(SwitchPosition_V1)

The physical location information of the switch including building, floor, and coordinates.

spanningTreePriorityinteger(int32)

The Spanning Tree Protocol bridge priority value, used in root bridge election (lower values have higher priority).

softDeletedDatestring(date-time)

The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.

stackMembersArray of objects(StackMembers_V1)

The list of member switches in a stack configuration, including their models and active status.

ipAddressInterfaceTypestring

The interface type for the switch management IP address: VLAN interface or management port.

Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring

The specific interface identifier for the management IP address configuration.

ipAddressTypestring

The IP address assignment method: static or DHCP.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to the switch management interface.

subnetMaskstring

The subnet mask for the switch management IP address.

defaultGatewaystring

The default gateway IP address for routing traffic from the switch management interface.

firmwareVersionstring

The current firmware version running on the switch.

previousMembersArray of stringsunique

The set of serial numbers for previous stack members that have been removed from the stack.

lastDataSyncTriggerTimeinteger(int64)

The timestamp in milliseconds when the last data synchronization was triggered for this switch.

lastDataSyncTimeinteger(int64)

The timestamp in milliseconds when the last data synchronization completed for this switch.

syncDataIdstring

The unique identifier for the current data synchronization operation.

syncDataStartTimeinteger(int64)

The timestamp in milliseconds when the current data synchronization operation started.

syncDataEndTimeinteger(int64)

The timestamp in milliseconds when the current data synchronization operation ended.

dhcpClientEnabledboolean

The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.

dhcpServerEnabledboolean

The flag indicating whether the DHCP server feature is enabled on the switch.

trustPortsArray of strings

The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.

initialVlanIdinteger(int32)

The VLAN ID used for initial switch configuration and management access.

stackConfigTimestampstring

The timestamp indicating when the stack configuration was last modified.

specifiedTypestring

The firmware image type specified for the switch: primary, secondary, or boot.

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

The model identifier of the rear expansion module installed on the switch, if applicable.

vlanCustomizeboolean

The flag indicating whether VLAN configurations have been customized from default settings.

Response
{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "description": "string",
  "tags": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "position": {
    "id": "string",
    "floorplanId": "string",
    "xPercent": 0.1,
    "yPercent": 0.1
  },
  "spanningTreePriority": 0,
  "softDeletedDate": "2019-08-24T14:15:22Z",
  "stackMembers": [
    { … }
  ],
  "ipAddressInterfaceType": "NONE",
  "ipAddressInterface": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "subnetMask": "string",
  "defaultGateway": "string",
  "firmwareVersion": "string",
  "previousMembers": [
    "string"
  ],
  "lastDataSyncTriggerTime": 0,
  "lastDataSyncTime": 0,
  "syncDataId": "string",
  "syncDataStartTime": 0,
  "syncDataEndTime": 0,
  "dhcpClientEnabled": true,
  "dhcpServerEnabled": true,
  "trustPorts": [
    "string"
  ],
  "initialVlanId": 0,
  "stackConfigTimestamp": "string",
  "specifiedType": "AUTO",
  "rearModule": "string",
  "vlanCustomize": true
}

Add ICX Switches

Request

Add multiple ICX switches. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
Body
requiredArray [
idstring
namestring

The name assigned to the ICX switch for identification in the network.

descriptionstring

The descriptive text providing additional information about the switch configuration or purpose.

enableStackboolean

The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.

igmpSnoopingstring

The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.

Enum"active""passive""none"
jumboModeboolean

The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.

spanningTreePriorityinteger(int32)

The Spanning Tree Protocol bridge priority value, used in root bridge election (lower values have higher priority).

StackMembers_V1_1Array of objects(StackMembers_V1_1)

The list of member switches in a stack configuration, including their models and active status.

ipAddressInterfaceTypestring

The interface type for the switch management IP address: VLAN interface or management port.

Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring

The specific interface identifier for the management IP address configuration.

ipAddressTypestring

The IP address assignment method: static or DHCP.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to the switch management interface.

subnetMaskstring

The subnet mask for the switch management IP address.

defaultGatewaystring

The default gateway IP address for routing traffic from the switch management interface.

dhcpClientEnabledboolean

The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.

dhcpServerEnabledboolean

The flag indicating whether the DHCP server feature is enabled on the switch.

initialVlanIdinteger(int32)

The VLAN ID used for initial switch configuration and management access.

specifiedTypestring

The firmware image type specified for the switch: primary, secondary, or boot.

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

The model identifier of the rear expansion module installed on the switch, if applicable.

vlanCustomizeboolean

The flag indicating whether VLAN configurations have been customized from default settings.

]
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "enableStack": true,
    "igmpSnooping": "active",
    "jumboMode": true,
    "spanningTreePriority": 0,
    "StackMembers_V1_1": [ … ],
    "ipAddressInterfaceType": "NONE",
    "ipAddressInterface": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "subnetMask": "string",
    "defaultGateway": "string",
    "dhcpClientEnabled": true,
    "dhcpServerEnabled": true,
    "initialVlanId": 0,
    "specifiedType": "AUTO",
    "rearModule": "string",
    "vlanCustomize": true
  }
]

Responses

Accepted

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"
  }
}

Delete ICX Switches

Request

Delete multiple ICX switches.

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

Responses

Accepted

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"
  }
}

Sync or Reboot ICX Device

Request

Execute sync or reboot command on the specified switch device.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
deviceRequestActionstring

The request action to the switches.

Enum"sync""reboot""syncAdminPassword"
switchIdListArray of strings

The list of switch id.

{
  "deviceRequestAction": "sync",
  "switchIdList": [
    "string"
  ]
}

Responses

Accepted

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"
  }
}

Create Multiple Device Requests

Request

Execute sync venues admin password on multiple switch devices, switch id list should be provided on the request body.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
deviceRequestActionstring

The request action to the switches.

Enum"sync""reboot""syncAdminPassword"
switchIdListArray of strings

The list of switch id.

{
  "deviceRequestAction": "sync",
  "switchIdList": [
    "string"
  ]
}

Responses

Accepted

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"
  }
}

Delete Stack Member

Request

Delete stack member.

Security
jwtAuth
Path
venueIdstringrequired
stackSwitchSerialNumberstringrequired
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"
  }
}

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

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