Skip to content
Switch Services/
/
Get Switches

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

Change Upgrade Schedule

Request

Schedule the firmware upgrade for venues. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
idstring
datestring

The scheduled date for the firmware upgrade operation in string format.

timestring

The scheduled time for the firmware upgrade operation in string format.

versionsArray of objects(ModelVersion_V1_1)unique

The set of model version pairs specifying target firmware versions for different switch models in this upgrade schedule.

switchIdsArray of strings

The list of switch identifiers to include in the scheduled firmware upgrade.

preDownloadboolean

The flag indicating whether to pre download the firmware before the scheduled upgrade time.

{
  "id": "string",
  "date": "string",
  "time": "string",
  "versions": [
    { … }
  ],
  "switchIds": [
    "string"
  ],
  "preDownload": 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"
  }
}

Create Upgrade Schedule

Request

Schedule the firmware upgrade for venues. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
Query
manualOverrideboolean
Default false
Body
required
idstring
datestring

The scheduled date for the firmware upgrade operation in string format.

timestring

The scheduled time for the firmware upgrade operation in string format.

switchVersionstring

The target firmware version for switches with version 10 or below.

switchVersionAboveTenstring

The target firmware version for switches with version above 10.

switchIdsArray of strings

The list of switch identifiers to include in the scheduled firmware upgrade.

preDownloadboolean

The flag indicating whether to pre download the firmware before the scheduled upgrade time.

{
  "id": "string",
  "date": "string",
  "time": "string",
  "switchVersion": "string",
  "switchVersionAboveTen": "string",
  "switchIds": [
    "string"
  ],
  "preDownload": true
}

Responses

Created

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 Upgrade Schedule

Request

Cancel the schedule for firmware upgrade.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
idstring
switchIdsArray of strings

The list of switch identifiers for which the scheduled firmware upgrade should be skipped or postponed.

{
  "id": "string",
  "switchIds": [
    "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"
  }
}

Get Switches

Request

Get all switches by tenant id for upgrading.

Security
jwtAuth
Body
required
searchFilterstring

Search filter string for filtering switches by name, model, or other attributes.

venueIdListArray of strings

List of venue identifiers to filter switches by venue.

{
  "searchFilter": "string",
  "venueIdList": [
    "string"
  ]
}

Responses

OK

Body
Array [
idstring
venueIdstring

The unique identifier of the venue where this switch is located.

venueNamestring

The name of the venue where this switch is located.

switchIdstring

The unique identifier of the switch for firmware upgrade operations.

switchNamestring

The name of the switch for identification and display purposes.

isStackboolean

The flag indicating whether this switch is part of a stack configuration.

modelstring

The switch model name or identifier.

currentFirmwarestring

The current firmware version running on the switch.

availableVersionobject(SwitchVersion_V1)

SwitchVersion attributes. Deprecated,this version, application/vnd.ruckus.v1+json will be removed no sooner than 08/31/2026.

switchNextScheduleobject(UpgradeSchedule_V1)

The next scheduled firmware upgrade at the switch level.

venueNextScheduleobject(UpgradeSchedule_V1)

The next scheduled firmware upgrade at the venue level affecting this switch.

preDownloadboolean

The flag indicating whether the firmware has been pre downloaded to the switch.

isSwitchLevelScheduleboolean

The flag indicating whether the upgrade schedule is defined at the switch level rather than venue level.

]
Response
[
  {
    "id": "string",
    "venueId": "string",
    "venueName": "string",
    "switchId": "string",
    "switchName": "string",
    "isStack": true,
    "model": "string",
    "currentFirmware": "string",
    "availableVersion": { … },
    "switchNextSchedule": { … },
    "venueNextSchedule": { … },
    "preDownload": true,
    "isSwitchLevelSchedule": true
  }
]

Get Venues

Request

Get all venues by tenant id for upgrading.

Security
jwtAuth
Body
required
searchFilterstring

Search filter string for filtering venues by name or other attributes.

firmwareVersionstring

Firmware version string to filter venues by switch firmware version.

{
  "searchFilter": "string",
  "firmwareVersion": "string"
}

Responses

OK

Body
Array [
idstring
venueIdstring

The unique identifier of the venue for firmware upgrade operations.

venueNamestring

The name of the venue for identification and display purposes.

switchFirmwareVersionobject(SwitchVersion_V1)

SwitchVersion attributes. Deprecated,this version, application/vnd.ruckus.v1+json will be removed no sooner than 08/31/2026.

switchFirmwareVersionAboveTenobject(SwitchVersion_V1)

SwitchVersion attributes. Deprecated,this version, application/vnd.ruckus.v1+json will be removed no sooner than 08/31/2026.

availableVersionsArray of objects(SwitchVersion_V1)

The list of available firmware versions that can be upgraded to for switches in this venue.

nextScheduleobject(UpgradeSchedule_V1)

The next scheduled firmware upgrade for this venue.

lastScheduleUpdateTimestring(date-time)

The timestamp of the last update to the firmware upgrade schedule for this venue.

preDownloadboolean

The flag indicating whether firmware pre download is enabled for switches in this venue.

switchCountinteger(int32)

The total number of switches in this venue.

aboveTenSwitchCountinteger(int32)

The number of switches with firmware version above 10 in this venue.

statusstring

The current firmware upgrade status for this venue, such as pending, in progress, or completed.

Enum"NONE""INITIATE""SUCCESS""FAILED"
scheduleCountinteger(int32)

The total number of scheduled firmware upgrades configured for this venue.

]
Response
[
  {
    "id": "string",
    "venueId": "string",
    "venueName": "string",
    "switchFirmwareVersion": { … },
    "switchFirmwareVersionAboveTen": { … },
    "availableVersions": [ … ],
    "nextSchedule": { … },
    "lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
    "preDownload": true,
    "switchCount": 0,
    "aboveTenSwitchCount": 0,
    "status": "NONE",
    "scheduleCount": 0
  }
]

Get Versions

Request

Get different version type of firmware.

Security
jwtAuth
Path
versionTypestringrequired
No request payload

Responses

OK

Body
Array [
idstring
namestring

The firmware version name identifier for the switch.

categorystring

The firmware version category, such as recommended, latest, or stable.

Enum"RECOMMENDED""CRITICAL""BETA""SOLO"
createdDatestring(date-time)

The date when this firmware version record was created in the system.

]
Response
[
  {
    "id": "string",
    "name": "string",
    "category": "RECOMMENDED",
    "createdDate": "2019-08-24T14:15:22Z"
  }
]

Get Current Versions

Request

Get current versions of the venues.

Security
jwtAuth
No request payload

Responses

OK

Body
idstring
currentVersionsArray of strings

The list of current firmware versions running on switches with version 10 or below in this venue.

currentVersionsAboveTenArray of strings

The list of current firmware versions running on switches with version above 10 in this venue.

Response
{
  "id": "string",
  "currentVersions": [
    "string"
  ],
  "currentVersionsAboveTen": [
    "string"
  ]
}

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