Skip to content
Switch Services/
/
Get LAGs

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

Get LAG

Request

Get LAG setting by id.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
lagIdstringrequired
No request payload

Responses

OK

Body
idstring
lagIdinteger(int32)

The unique identifier of the LAG interface.

namestring

The name of the LAG interface.

typestring

The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).

Enum"static""dynamic"
portsArray of stringsunique

The set of physical port identifiers that are members of this LAG.

taggedVlansArray of stringsunique

The set of VLAN identifiers that are tagged on this LAG interface.

untaggedVlanstring

The VLAN identifier for untagged traffic on this LAG interface.

forceUpPortstring

The port identifier to force into an up state within the LAG.

Response
{
  "id": "string",
  "lagId": 0,
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "forceUpPort": "string"
}

Update LAG

Request

Update switch's LAG setting.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
lagIdstringrequired
Body
required
namestring

The name of the LAG interface.

typestring

The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).

Enum"static""dynamic"
portsArray of stringsunique

The set of physical port identifiers that are members of this LAG.

taggedVlansArray of stringsunique

The set of VLAN identifiers that are tagged on this LAG interface.

untaggedVlanstring

The VLAN identifier for untagged traffic on this LAG interface.

forceUpPortstring

The port identifier to force into an up state within the LAG.

{
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "forceUpPort": "string"
}

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(Lag_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "forceUpPort": "string"
  }
}

Delete LAG

Request

Delete switch's LAG setting.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
lagIdstringrequired
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 LAGs

Request

List of switch's LAG settings.

Security
jwtAuth
Path
switchIdstringrequired
venueIdstringrequired
No request payload

Responses

OK

Body
Array [
idstring
lagIdinteger(int32)

The unique identifier of the LAG interface.

namestring

The name of the LAG interface.

typestring

The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).

Enum"static""dynamic"
portsArray of stringsunique

The set of physical port identifiers that are members of this LAG.

taggedVlansArray of stringsunique

The set of VLAN identifiers that are tagged on this LAG interface.

untaggedVlanstring

The VLAN identifier for untagged traffic on this LAG interface.

forceUpPortstring

The port identifier to force into an up state within the LAG.

]
Response
[
  {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "forceUpPort": "string"
  }
]

Add LAGs

Request

Add switch's multiple LAG settings.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
requiredArray [
namestring

The name of the LAG interface.

typestring

The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).

Enum"static""dynamic"
portsArray of stringsunique

The set of physical port identifiers that are members of this LAG.

taggedVlansArray of stringsunique

The set of VLAN identifiers that are tagged on this LAG interface.

untaggedVlanstring

The VLAN identifier for untagged traffic on this LAG interface.

forceUpPortstring

The port identifier to force into an up state within the LAG.

]
[
  {
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "forceUpPort": "string"
  }
]

Responses

Created

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(Lag_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "forceUpPort": "string"
  }
}

Delete LAGs

Request

Delete switch's multiple LAG settings.

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

Profile

Manage switch profiles and profile configurations.

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

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