Skip to content
/
Get ICX Switch

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

Get ICX Switch

Request

Get ICX switch by id.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring
descriptionstring
enableStackboolean
igmpSnoopingstring
Enum"active""passive""none"
jumboModeboolean
spanningTreePriorityinteger(int32)
stackMembersArray of objects(StackMembersViewV1001)
ipAddressInterfaceTypestring
Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
subnetMaskstring
defaultGatewaystring
dhcpClientEnabledboolean
dhcpServerEnabledboolean
initialVlanIdinteger(int32)
specifiedTypestring
Enum"AUTO""SWITCH""ROUTER"
rearModulestring
vlanCustomizeboolean
Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "spanningTreePriority": 0,
  "stackMembers": [
    { … }
  ],
  "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
descriptionstring
enableStackboolean
igmpSnoopingstring
Enum"active""passive""none"
jumboModeboolean
spanningTreePriorityinteger(int32)
stackMembersArray of objects(StackMembersViewV1001)
ipAddressInterfaceTypestring
Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
subnetMaskstring
defaultGatewaystring
dhcpClientEnabledboolean
dhcpServerEnabledboolean
initialVlanIdinteger(int32)
specifiedTypestring
Enum"AUTO""SWITCH""ROUTER"
rearModulestring
vlanCustomizeboolean
{
  "id": "string",
  "name": "string",
  "description": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "spanningTreePriority": 0,
  "stackMembers": [
    { … }
  ],
  "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
responseobject(IcxSwitchViewV1001)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "enableStack": true,
    "igmpSnooping": "active",
    "jumboMode": true,
    "spanningTreePriority": 0,
    "stackMembers": [ … ],
    "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
descriptionstring
enableStackboolean
igmpSnoopingstring
Enum"active""passive""none"
jumboModeboolean
spanningTreePriorityinteger(int32)
stackMembersArray of objects(StackMembersViewV1001)
ipAddressInterfaceTypestring
Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
subnetMaskstring
defaultGatewaystring
dhcpClientEnabledboolean
dhcpServerEnabledboolean
initialVlanIdinteger(int32)
specifiedTypestring
Enum"AUTO""SWITCH""ROUTER"
rearModulestring
vlanCustomizeboolean
{
  "id": "string",
  "name": "string",
  "description": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "spanningTreePriority": 0,
  "stackMembers": [
    { … }
  ],
  "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
responseobject(EmptyView)
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
responseobject(EmptyView)
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
xPercentnumber(float)
yPercentnumber(float)
{
  "floorPlanId": "string",
  "xPercent": 0.1,
  "yPercent": 0.1
}

Responses

Accepted

Body
requestIdstring
responseobject(EmptyView)
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
venueIdstring
namestring
descriptionstring
tagsstring
enableStackboolean
igmpSnoopingstring
Enum"active""passive""none"
jumboModeboolean
positionobject(SwitchPositionView)
spanningTreePriorityinteger(int32)
softDeletedDatestring(date-time)
stackMembersArray of objects(StackMembersView)
ipAddressInterfaceTypestring
Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
subnetMaskstring
defaultGatewaystring
firmwareVersionstring
previousMembersArray of stringsunique
lastDataSyncTriggerTimeinteger(int64)
lastDataSyncTimeinteger(int64)
syncDataIdstring
syncDataStartTimeinteger(int64)
syncDataEndTimeinteger(int64)
dhcpClientEnabledboolean
dhcpServerEnabledboolean
trustPortsArray of strings
initialVlanIdinteger(int32)
stackConfigTimestampstring
specifiedTypestring
Enum"AUTO""SWITCH""ROUTER"
rearModulestring
vlanCustomizeboolean
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
descriptionstring
enableStackboolean
igmpSnoopingstring
Enum"active""passive""none"
jumboModeboolean
spanningTreePriorityinteger(int32)
stackMembersArray of objects(StackMembersViewV1001)
ipAddressInterfaceTypestring
Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
subnetMaskstring
defaultGatewaystring
dhcpClientEnabledboolean
dhcpServerEnabledboolean
initialVlanIdinteger(int32)
specifiedTypestring
Enum"AUTO""SWITCH""ROUTER"
rearModulestring
vlanCustomizeboolean
]
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "enableStack": true,
    "igmpSnooping": "active",
    "jumboMode": true,
    "spanningTreePriority": 0,
    "stackMembers": [ … ],
    "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
responseobject(EmptyView)
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
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Sync/Reboot ICX Device

Request

Execute sync or reboot command on the specified switch device, no need to provide switch id list on the request body.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
deviceRequestActionstring
Enum"sync""reboot""syncAdminPassword"
switchIdListArray of strings
{
  "deviceRequestAction": "sync",
  "switchIdList": [
    "string"
  ]
}

Responses

Accepted

Body
requestIdstring
responseobject(EmptyView)
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
Enum"sync""reboot""syncAdminPassword"
switchIdListArray of strings
{
  "deviceRequestAction": "sync",
  "switchIdList": [
    "string"
  ]
}

Responses

Accepted

Body
requestIdstring
responseobject(EmptyView)
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
responseobject(EmptyView)
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