Manage AAA (authentication, authorization, and accounting) servers.
Switch Services (0.4.0)
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.
- 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
All API calls require valid authentication via JWT (JSON Web Token) in Authorization header.
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
The API uses standard HTTP status codes with detailed error messages in the response body.
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.
- RUCKUS One API host for North American region.https://api.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadOK
- application/json
- application/vnd.ruckus.v1+json
The switch family identifier for the root bridge in spanning tree topology.
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
The IGMP version number used for multicast group management in this VLAN.
The STP (Spanning Tree Protocol) variant enabled for this VLAN.
The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
{ "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": [ { … } ] }
- application/json
- application/vnd.ruckus.v1+json
Root bridge family ID for spanning tree protocol.
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
IGMP snooping mode for multicast traffic optimization.
STP (Spanning Tree Protocol) mode for loop prevention.
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Set of switch family model configurations for this VLAN.
Flag indicating whether this is a management VLAN for switch management access (default: false).
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
- RUCKUS One API host for North American region.https://api.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "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 }
OK
- application/json
- application/vnd.ruckus.v1+json
The switch family identifier for the root bridge in spanning tree topology.
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
The IGMP version number used for multicast group management in this VLAN.
The STP (Spanning Tree Protocol) variant enabled for this VLAN.
The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
{ "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": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/switchProfiles/{switchProfileId}/vlans/{vlanId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payload{ "requestId": "string", "response": { "id": "string" } }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/venues/{venueId}/vlans
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/venues/{venueId}/vlans
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/venues/{venueId}/vlans
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadOK
- application/json
- application/vnd.ruckus.v1+json
The switch family identifier for the root bridge in spanning tree topology.
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
The IGMP version number used for multicast group management in this VLAN.
The STP (Spanning Tree Protocol) variant enabled for this VLAN.
The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
{ "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": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/venues/{venueId}/untaggedVlans/query
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/venues/{venueId}/untaggedVlans/query
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/venues/{venueId}/untaggedVlans/query
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "model": "ICX7150-24" }
OK
- application/json
- application/vnd.ruckus.v1+json
The switch family identifier for the root bridge in spanning tree topology.
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
The IGMP version number used for multicast group management in this VLAN.
The STP (Spanning Tree Protocol) variant enabled for this VLAN.
The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
{ "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": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/venues/{venueId}/taggedVlans/query
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/venues/{venueId}/taggedVlans/query
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/venues/{venueId}/taggedVlans/query
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "model": "ICX7150-24" }
OK
- application/json
- application/vnd.ruckus.v1+json
The switch family identifier for the root bridge in spanning tree topology.
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
The IGMP version number used for multicast group management in this VLAN.
The STP (Spanning Tree Protocol) variant enabled for this VLAN.
The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
{ "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": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/switchProfiles/{switchProfileId}/vlans
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/switchProfiles/{switchProfileId}/vlans
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/switchProfiles/{switchProfileId}/vlans
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadOK
- application/json
- application/vnd.ruckus.v1+json
The switch family identifier for the root bridge in spanning tree topology.
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
The IGMP version number used for multicast group management in this VLAN.
The STP (Spanning Tree Protocol) variant enabled for this VLAN.
The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
{ "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": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/switchProfiles/{switchProfileId}/vlans
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/switchProfiles/{switchProfileId}/vlans
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/switchProfiles/{switchProfileId}/vlans
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
[ "string" ]
{ "requestId": "string", "response": { "id": "string" } }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/switches/{switchId}/vlanUnions
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/switches/{switchId}/vlanUnions
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/switches/{switchId}/vlanUnions
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payload{ "switchDefaultVlan": [ { … } ], "profileVlan": [ { … } ], "switchVlan": [ { … } ] }