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

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Operations

Get Virtual Ethernet Setting

Request

Get a specified virtual ethernet port.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
vePortIdstringrequired
No request payload

Responses

OK

Body
idstring
veIdinteger(int32)

The virtual ethernet interface identifier, used as the VE interface number.

vlanIdinteger(int32)

The VLAN ID associated with this virtual ethernet interface for Layer 3 routing.

namestring^(?:(?!").){1,64}$

The descriptive name assigned to the virtual ethernet interface.

ospfAreastring

The OSPF area identifier for routing protocol configuration on this VE interface.

dhcpRelayAgentstring

The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.

ipAddressTypestring

The IP address assignment method for this VE interface: static or dynamic.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to this virtual ethernet interface.

ipSubnetMaskstring

The subnet mask for the IP address of this virtual ethernet interface.

ingressAclNamestring

The name of the Access Control List applied to ingress traffic on this VE interface.

egressAclNamestring

The name of the Access Control List applied to egress traffic on this VE interface.

connectedVeboolean

The flag indicating whether this VE interface is connected and operational.

switchIdstring

The identifier of the switch where this VE interface is configured.

switchNamestring

The name of the switch where this VE interface is configured.

deviceStatusstring

The operational status of the device associated with this VE interface.

syncedSwitchConfigboolean

The flag indicating whether the VE interface configuration has been synchronized with the switch.

vsixIngressAclNamestring

The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

vsixEgressAclNamestring

The name of the VSIX ACL applied to egress traffic for virtual switch integration.

Response
{
  "id": "string",
  "veId": 0,
  "vlanId": 0,
  "name": "string",
  "ospfArea": "string",
  "dhcpRelayAgent": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "ipSubnetMask": "string",
  "ingressAclName": "string",
  "egressAclName": "string",
  "connectedVe": true,
  "switchId": "string",
  "switchName": "string",
  "deviceStatus": "string",
  "syncedSwitchConfig": true,
  "vsixIngressAclName": "string",
  "vsixEgressAclName": "string"
}

Update Virtual Ethernet Setting

Request

Update virtual ethernet port.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
vePortIdstringrequired
Body
required
veIdinteger(int32)

The virtual ethernet interface identifier, used as the VE interface number.

vlanIdinteger(int32)

The VLAN ID associated with this virtual ethernet interface for Layer 3 routing.

namestring

The descriptive name assigned to the virtual ethernet interface.

ospfAreastring

The OSPF area identifier for routing protocol configuration on this VE interface.

dhcpRelayAgentstring

The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.

ipAddressTypestring

The IP address assignment method for this VE interface: static or dynamic.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to this virtual ethernet interface.

ipSubnetMaskstring

The subnet mask for the IP address of this virtual ethernet interface.

ingressAclstring

The name of the Access Control List applied to ingress traffic on this VE interface.

egressAclstring

The name of the Access Control List applied to egress traffic on this VE interface.

{
  "veId": 0,
  "vlanId": 0,
  "name": "string",
  "ospfArea": "string",
  "dhcpRelayAgent": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "ipSubnetMask": "string",
  "ingressAcl": "string",
  "egressAcl": "string"
}

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(VePort_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "connectedVe": true,
    "switchId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "syncedSwitchConfig": true,
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string"
  }
}

Delete Virtual Ethernet Setting

Request

Delete virtual ethernet port.

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

Retrieve Virtual Ethernet Settings

Request

Retrieve virtual ethernet ports of venue by query.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
fieldsArray of strings

The list of field names to include in the query response, allowing clients to request only specific fields.

pageinteger(int32)

The page number for pagination, starting from 1, defaulting to 1.

pageSizeinteger(int32)

The number of records to return per page, defaulting to 25.

sortFieldstring

The field name to use for sorting the query results.

sortOrderstring

The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Enum"ASC""DESC"
filtersobject

The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.

filterTypestringDeprecated

The dynamic filter type (deprecated, use filters instead).

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "filterType": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Body
idstring
dataArray of objects

The list of data records returned by the query, with each item representing a result object.

fieldsArray of strings

The list of field names included in the query response data.

pageinteger(int32)

The current page number of the paginated results.

totalCountinteger(int64)

The total number of records matching the query criteria across all pages.

totalPagesinteger(int32)

The total number of pages available based on the page size and total record count.

Response
{
  "id": "string",
  "data": [
    null
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Retrieve Virtual Ethernet Settings

Request

Retrieve virtual ethernet ports of the specified switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

OK

Body
Array [
idstring
veIdinteger(int32)

The virtual ethernet interface identifier, used as the VE interface number.

vlanIdinteger(int32)

The VLAN ID associated with this virtual ethernet interface for Layer 3 routing.

namestring^(?:(?!").){1,64}$

The descriptive name assigned to the virtual ethernet interface.

ospfAreastring

The OSPF area identifier for routing protocol configuration on this VE interface.

dhcpRelayAgentstring

The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.

ipAddressTypestring

The IP address assignment method for this VE interface: static or dynamic.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to this virtual ethernet interface.

ipSubnetMaskstring

The subnet mask for the IP address of this virtual ethernet interface.

ingressAclNamestring

The name of the Access Control List applied to ingress traffic on this VE interface.

egressAclNamestring

The name of the Access Control List applied to egress traffic on this VE interface.

connectedVeboolean

The flag indicating whether this VE interface is connected and operational.

switchIdstring

The identifier of the switch where this VE interface is configured.

switchNamestring

The name of the switch where this VE interface is configured.

deviceStatusstring

The operational status of the device associated with this VE interface.

syncedSwitchConfigboolean

The flag indicating whether the VE interface configuration has been synchronized with the switch.

vsixIngressAclNamestring

The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

vsixEgressAclNamestring

The name of the VSIX ACL applied to egress traffic for virtual switch integration.

]
Response
[
  {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "connectedVe": true,
    "switchId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "syncedSwitchConfig": true,
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string"
  }
]

Add Virtual Ethernet Settings

Request

Add virtual ethernet ports of the switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
requiredArray [
veIdinteger(int32)

The virtual ethernet interface identifier, used as the VE interface number.

vlanIdinteger(int32)

The VLAN ID associated with this virtual ethernet interface for Layer 3 routing.

namestring

The descriptive name assigned to the virtual ethernet interface.

ospfAreastring

The OSPF area identifier for routing protocol configuration on this VE interface.

dhcpRelayAgentstring

The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.

ipAddressTypestring

The IP address assignment method for this VE interface: static or dynamic.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to this virtual ethernet interface.

ipSubnetMaskstring

The subnet mask for the IP address of this virtual ethernet interface.

ingressAclstring

The name of the Access Control List applied to ingress traffic on this VE interface.

egressAclstring

The name of the Access Control List applied to egress traffic on this VE interface.

]
[
  {
    "veId": 0,
    "vlanId": 0,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAcl": "string",
    "egressAcl": "string"
  }
]

Responses

Created

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(VePort_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "connectedVe": true,
    "switchId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "syncedSwitchConfig": true,
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string"
  }
}

Delete Virtual Ethernet Settings

Request

Delete multiple virtual ethernet ports.

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

Retrieve Virtual Ethernet Settings

Request

Retrieve virtual ethernet ports of switch by query.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
fieldsArray of strings

The list of field names to include in the query response, allowing clients to request only specific fields.

pageinteger(int32)

The page number for pagination, starting from 1, defaulting to 1.

pageSizeinteger(int32)

The number of records to return per page, defaulting to 25.

sortFieldstring

The field name to use for sorting the query results.

sortOrderstring

The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Enum"ASC""DESC"
filtersobject

The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.

filterTypestringDeprecated

The dynamic filter type (deprecated, use filters instead).

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "filterType": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Body
idstring
dataArray of objects

The list of data records returned by the query, with each item representing a result object.

fieldsArray of strings

The list of field names included in the query response data.

pageinteger(int32)

The current page number of the paginated results.

totalCountinteger(int64)

The total number of records matching the query criteria across all pages.

totalPagesinteger(int32)

The total number of pages available based on the page size and total record count.

Response
{
  "id": "string",
  "data": [
    null
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

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