Skip to content
/Switch VLAN

Switch Services (0.4.0)

Overview

The Switch Service REST API facilitates the management and configuration of RUCKUS ICX switches via the RUCKUS One platform. This API allows for programmatic control of switch operations, network configurations, security policies, and monitoring across various environments.

What This API Does

  • Manage ICX switch devices and their configurations
  • Configure network settings including VLANs, ports, LAGs, and virtual ethernet interfaces
  • Control security policies with AAA servers, ACLs, and trusted port settings
  • Create and apply switch profiles and templates for consistent configurations
  • Handle firmware upgrades and configuration backups
  • Configure DHCP servers and static routing
  • Import and onboard new switches to the platform
  • Manage CLI templates and web authentication pages

Authentication

All API calls require valid authentication via JWT (JSON Web Token) in Authorization header.

Regional Endpoints

Select the appropriate API endpoint based on your region:

  • North America: https://api.ruckus.cloud
  • Europe: https://api.eu.ruckus.cloud
  • Asia: https://api.asia.ruckus.cloud

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors.
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 switch configuration history records.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX switch settings.

Operations

Import Switch

Import and register new switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles and profile configurations.

Operations

Profile ACL

Manage ACL (access control list) of switch profile.

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 switch configuration backups and restore operations.

Operations

Switch Firmware Upgrade

Manage switch firmware upgrade and scheduling operations.

Operations

Switch Ports

Manage switch port configurations.

Operations

Switch Static Routes

Manage static route configurations.

Operations

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Get Switch VLANDeprecated

Request

Get the specified switch level VLAN by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans/{vlanId} can be used for this content.

Security
jwtAuth
Path
vlanIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

vlanIdinteger(int32)

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

vlanNamestring

The descriptive name assigned to this VLAN for identification purposes.

ipv4DhcpSnoopingboolean

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

arpInspectionboolean

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

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 STP (Spanning Tree Protocol) variant enabled for this VLAN.

Enum"rstp""stp""none"
taggedPortsstring

The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.

untaggedPortsstring

The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.

vePortobject(VePort_V1)

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

switchVlanPortModelsArray of objects(SwitchVlanPortModelBo)unique

The set of port model configurations specific to this VLAN on different switch models in a stack.

enableAsDefaultVlanboolean

The flag indicating whether this VLAN is configured as the default VLAN for the switch.

Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "ipv4DhcpSnooping": true,
  "arpInspection": true,
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "taggedPorts": "string",
  "untaggedPorts": "string",
  "vePort": {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "defaultVlan": true,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string",
    "switchId": "string",
    "tenantId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "stack": true,
    "syncedSwitchConfig": true,
    "portType": "NONE",
    "connectedVe": true,
    "vePortViewList": [ … ]
  },
  "switchVlanPortModels": [
    { … }
  ],
  "enableAsDefaultVlan": true
}

Update Switch VLANDeprecated

Request

Update a VLAN of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans/{vlanId} can be used for this content.

Security
jwtAuth
Path
vlanIdstringrequired
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).

ipv6DhcpSnoopingTrustPortstring

Comma separated list of trusted port identifiers for IPv6 DHCP snooping.

ipv6DhcpSnoopingTrustPortListArray of strings

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

arpInspectionboolean

Enable ARP inspection to prevent ARP spoofing attacks (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.

ipv6NdInspectionboolean

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

ipv6NdInspectionTrustPortstring

Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.

ipv6NdInspectionTrustPortListArray of strings

List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.

arpTrustPortsListArray of strings

List of ARP trusted ports for internal use.

dhcpTrustPortsListArray of strings

List of DHCP trusted ports for internal use.

ipv6DhcpTrustPortsListArray of strings

List of IPv6 DHCP trusted ports for internal use.

ipv6NdTrustPortsListArray of strings

List of IPv6 ND (Neighbor Discovery) 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

STP (Spanning Tree Protocol) mode for loop prevention.

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,
  "ipv6DhcpSnoopingTrustPort": "string",
  "ipv6DhcpSnoopingTrustPortList": [
    "string"
  ],
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "arpInspectionTrustPortList": [
    "string"
  ],
  "ipv6NdInspection": true,
  "ipv6NdInspectionTrustPort": "string",
  "ipv6NdInspectionTrustPortList": [
    "string"
  ],
  "arpTrustPortsList": [
    "string"
  ],
  "dhcpTrustPortsList": [
    "string"
  ],
  "ipv6DhcpTrustPortsList": [
    "string"
  ],
  "ipv6NdTrustPortsList": [
    "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 on the switch.

vlanNamestring

The descriptive name assigned to this VLAN for identification purposes.

ipv4DhcpSnoopingboolean

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

arpInspectionboolean

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

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 STP (Spanning Tree Protocol) variant enabled for this VLAN.

Enum"rstp""stp""none"
taggedPortsstring

The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.

untaggedPortsstring

The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.

vePortobject(VePort_V1)

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

switchVlanPortModelsArray of objects(SwitchVlanPortModelBo)unique

The set of port model configurations specific to this VLAN on different switch models in a stack.

enableAsDefaultVlanboolean

The flag indicating whether this VLAN is configured as the default VLAN for the switch.

Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "ipv4DhcpSnooping": true,
  "arpInspection": true,
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "taggedPorts": "string",
  "untaggedPorts": "string",
  "vePort": {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "defaultVlan": true,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string",
    "switchId": "string",
    "tenantId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "stack": true,
    "syncedSwitchConfig": true,
    "portType": "NONE",
    "connectedVe": true,
    "vePortViewList": [ … ]
  },
  "switchVlanPortModels": [
    { … }
  ],
  "enableAsDefaultVlan": true
}

Delete Switch VLANDeprecated

Request

Delete a VLAN of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans/{vlanId} can be used for this content.

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

Get Switch VLANsDeprecated

Request

Get switch level VLANs by switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

vlanIdinteger(int32)

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

vlanNamestring

The descriptive name assigned to this VLAN for identification purposes.

ipv4DhcpSnoopingboolean

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

arpInspectionboolean

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

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 STP (Spanning Tree Protocol) variant enabled for this VLAN.

Enum"rstp""stp""none"
taggedPortsstring

The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.

untaggedPortsstring

The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.

vePortobject(VePort_V1)

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

switchVlanPortModelsArray of objects(SwitchVlanPortModelBo)unique

The set of port model configurations specific to this VLAN on different switch models in a stack.

enableAsDefaultVlanboolean

The flag indicating whether this VLAN is configured as the default VLAN for the switch.

Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "ipv4DhcpSnooping": true,
  "arpInspection": true,
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "taggedPorts": "string",
  "untaggedPorts": "string",
  "vePort": {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "defaultVlan": true,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string",
    "switchId": "string",
    "tenantId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "stack": true,
    "syncedSwitchConfig": true,
    "portType": "NONE",
    "connectedVe": true,
    "vePortViewList": [ … ]
  },
  "switchVlanPortModels": [
    { … }
  ],
  "enableAsDefaultVlan": true
}

Add Switch VLANDeprecated

Request

Create a VLAN of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
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).

ipv6DhcpSnoopingTrustPortstring

Comma separated list of trusted port identifiers for IPv6 DHCP snooping.

ipv6DhcpSnoopingTrustPortListArray of strings

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

arpInspectionboolean

Enable ARP inspection to prevent ARP spoofing attacks (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.

ipv6NdInspectionboolean

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

ipv6NdInspectionTrustPortstring

Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.

ipv6NdInspectionTrustPortListArray of strings

List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.

arpTrustPortsListArray of strings

List of ARP trusted ports for internal use.

dhcpTrustPortsListArray of strings

List of DHCP trusted ports for internal use.

ipv6DhcpTrustPortsListArray of strings

List of IPv6 DHCP trusted ports for internal use.

ipv6NdTrustPortsListArray of strings

List of IPv6 ND (Neighbor Discovery) 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

STP (Spanning Tree Protocol) mode for loop prevention.

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,
  "ipv6DhcpSnoopingTrustPort": "string",
  "ipv6DhcpSnoopingTrustPortList": [
    "string"
  ],
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "arpInspectionTrustPortList": [
    "string"
  ],
  "ipv6NdInspection": true,
  "ipv6NdInspectionTrustPort": "string",
  "ipv6NdInspectionTrustPortList": [
    "string"
  ],
  "arpTrustPortsList": [
    "string"
  ],
  "dhcpTrustPortsList": [
    "string"
  ],
  "ipv6DhcpTrustPortsList": [
    "string"
  ],
  "ipv6NdTrustPortsList": [
    "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 on the switch.

vlanNamestring

The descriptive name assigned to this VLAN for identification purposes.

ipv4DhcpSnoopingboolean

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

arpInspectionboolean

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

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 STP (Spanning Tree Protocol) variant enabled for this VLAN.

Enum"rstp""stp""none"
taggedPortsstring

The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.

untaggedPortsstring

The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.

vePortobject(VePort_V1)

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

switchVlanPortModelsArray of objects(SwitchVlanPortModelBo)unique

The set of port model configurations specific to this VLAN on different switch models in a stack.

enableAsDefaultVlanboolean

The flag indicating whether this VLAN is configured as the default VLAN for the switch.

Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "ipv4DhcpSnooping": true,
  "arpInspection": true,
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "taggedPorts": "string",
  "untaggedPorts": "string",
  "vePort": {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "defaultVlan": true,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string",
    "switchId": "string",
    "tenantId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "stack": true,
    "syncedSwitchConfig": true,
    "portType": "NONE",
    "connectedVe": true,
    "vePortViewList": [ … ]
  },
  "switchVlanPortModels": [
    { … }
  ],
  "enableAsDefaultVlan": true
}

Query Switch VLANsDeprecated

Request

Query the switch's switch level VLANs. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans/query can be used for this content.

Security
jwtAuth
Path
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.

searchStringstring

The search string for full text search across the specified target fields.

searchTargetFieldsArray of strings

The list of field names to search within when applying the search string.

filterTypestringDeprecated

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

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

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
}

Add Switch VLANsDeprecated

Request

Create multiple VLANs under the specified switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/vlans can be used for this content.

Security
jwtAuth
Body
requiredArray [
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).

ipv6DhcpSnoopingTrustPortstring

Comma separated list of trusted port identifiers for IPv6 DHCP snooping.

ipv6DhcpSnoopingTrustPortListArray of strings

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

arpInspectionboolean

Enable ARP inspection to prevent ARP spoofing attacks (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.

ipv6NdInspectionboolean

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

ipv6NdInspectionTrustPortstring

Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.

ipv6NdInspectionTrustPortListArray of strings

List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.

arpTrustPortsListArray of strings

List of ARP trusted ports for internal use.

dhcpTrustPortsListArray of strings

List of DHCP trusted ports for internal use.

ipv6DhcpTrustPortsListArray of strings

List of IPv6 DHCP trusted ports for internal use.

ipv6NdTrustPortsListArray of strings

List of IPv6 ND (Neighbor Discovery) 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

STP (Spanning Tree Protocol) mode for loop prevention.

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": [ … ],
    "ipv6DhcpSnooping": true,
    "ipv6DhcpSnoopingTrustPort": "string",
    "ipv6DhcpSnoopingTrustPortList": [ … ],
    "arpInspection": true,
    "arpInspectionTrustPort": "string",
    "arpInspectionTrustPortList": [ … ],
    "ipv6NdInspection": true,
    "ipv6NdInspectionTrustPort": "string",
    "ipv6NdInspectionTrustPortList": [ … ],
    "arpTrustPortsList": [ … ],
    "dhcpTrustPortsList": [ … ],
    "ipv6DhcpTrustPortsList": [ … ],
    "ipv6NdTrustPortsList": [ … ],
    "igmpSnooping": "active",
    "multicastVersion": 3,
    "spanningTreeProtocol": "rstp",
    "spanningTreePriority": 65535,
    "switchFamilyModels": [ … ],
    "managementVlan": true,
    "switchVlanPortModels": [ … ],
    "switchId": "string",
    "enableAsDefaultVlan": true
  }
]

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

Delete Switch VLANsDeprecated

Request

Delete multiple VLANs of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans can be used for this content.

Security
jwtAuth
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 Switch VLANsDeprecated

Request

Retrieve all usable VLANs under the specified switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/vlans/query can be used for this content.

Security
jwtAuth
Body
required
isDefaultboolean

Flag indicating whether this is a default VLAN operation (default: false).

switchIdsArray of strings

List of switch identifiers (serial numbers) to perform the VLAN operation on.

{
  "isDefault": true,
  "switchIds": [
    "string"
  ]
}

Responses

OK

Body
idstring

The identifier

switchIdstring

Switch identifier (serial number).

defaultVlanIdinteger(int32)

Default VLAN identifier for the switch (typically 1).

vlanListArray of objects(SwitchVlan_V1)

List of VLAN configurations present on the switch.

Response
{
  "id": "string",
  "switchId": "string",
  "defaultVlanId": 0,
  "vlanList": [
    { … }
  ]
}

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Operations

Trusted Port

Manage a port's trust 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