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

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

Get Venue Upgrade StatusesDeprecated

Request

Get venue upgrade status by venue id for upgrading. This method will be removed no sooner than 08/31/2026.

Security

jwtAuth

Body

required

venueIdstring

The identifier of venue.

{
  "venueId": "string"
}

Responses

Body

idstring

The identifier

switchIdstring

The unique identifier of the switch being upgraded.

switchNamestring

The name of the switch being upgraded.

statusstring

The current status of the firmware upgrade process.

targetFirmwarestring

The target firmware version for this upgrade.

switchStatusstring

The operational status of the switch during the upgrade.

Enum"ONLINE""OFFLINE""PROVISION""DISCOVERY""HBLOST""REBOOTING""FIRMWARE_UPGRADING""UNRECOGNIZED""RELOADING""PRIME_UPGRADE_COMPLETED"

lastStatusUpdateTimestring(date-time)

The timestamp of the last status update for this upgrade process.

upgradeStatusDetailsViewListArray of objects(UpgradeStatusDetailsView_V1)

The list of upgrade status details for batch operations or nested status tracking.

Response

{
  "id": "string",
  "switchId": "string",
  "switchName": "string",
  "status": "string",
  "targetFirmware": "string",
  "switchStatus": "ONLINE",
  "lastStatusUpdateTime": "2019-08-24T14:15:22Z",
  "upgradeStatusDetailsViewList": [
    {}
  ]
}

Get SwitchesDeprecated

Request

Get all switches by tenant id for upgrading. This method will be removed no sooner than 08/31/2026. The following URL /switchFirmwares/schedules/switches/query can be used for this content.

Security

jwtAuth

Body

required

searchstring

The search term for filtering switches by name, MAC address, or identifier.

venueIdListArray of strings

The list of venue identifiers to filter switches by their associated venues.

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

Responses

Body

idstring

The identifier

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 to be upgraded.

switchNamestring

The name of the switch for identification in the upgrade process.

isStackboolean

The flag indicating whether this is a stacked switch configuration.

modelstring

The model name or identifier of the ICX switch.

currentFirmwarestring

The current firmware version running on the switch.

availableVersionobject(SwitchVersion)

The available firmware version that can be deployed to this switch.

switchNextScheduleobject(UpgradeScheduleView)

The next scheduled firmware upgrade for this specific switch.

venueNextScheduleobject(UpgradeScheduleView)

The next scheduled firmware upgrade at the venue level that applies to this switch.

preDownloadboolean

The flag indicating whether firmware pre download is enabled for this switch.

isSwitchLevelScheduleboolean

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

upgradeSwitchViewListArray of objects(UpgradeSwitchView)

The list of upgrade switch views for batch operations or nested switch management.

Response

{
  "id": "string",
  "venueId": "string",
  "venueName": "string",
  "switchId": "string",
  "switchName": "string",
  "isStack": true,
  "model": "string",
  "currentFirmware": "string",
  "availableVersion": {
    "name": "string",
    "category": "RECOMMENDED"
  },
  "switchNextSchedule": {
    "id": "string",
    "timeSlot": { … },
    "version": { … },
    "versionAboveTen": { … }
  },
  "venueNextSchedule": {
    "id": "string",
    "timeSlot": { … },
    "version": { … },
    "versionAboveTen": { … }
  },
  "preDownload": true,
  "isSwitchLevelSchedule": true,
  "upgradeSwitchViewList": [
    {}
  ]
}

Create Upgrade ScheduleDeprecated

Request

Schedule the firmware upgrade for venues. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switchFirmwares/schedules can be used for this content.

Security

jwtAuth

Body

required

idstring

The identifier

datestring

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

timestring

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

switchVersionstring

The target firmware version for switches with version numbers below 10.0.0.

switchVersionAboveTenstring

The target firmware version for switches with version numbers 10.0.0 and above.

venueIdsArray of strings

The list of venue identifiers affected by this schedule change.

switchIdsArray of strings

The list of switch identifiers affected by this schedule change.

preDownloadboolean

The flag indicating whether firmware pre download should be enabled before the scheduled upgrade.

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

Responses

Body

responsestring

The response data containing the result of the operation.

Response

{
  "response": "string"
}

Delete Upgrade ScheduleDeprecated

Request

Cancel the schedule for firmware upgrade. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switchFirmwares/schedules can be used for this content.

Security

jwtAuth

Body

required

idstring

The identifier

venueIdsArray of strings

The list of venue identifiers for which the scheduled firmware upgrade should be skipped.

switchIdsArray of strings

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

{
  "id": "string",
  "venueIds": [
    "string"
  ],
  "switchIds": [
    "string"
  ]
}

Responses

Body

responsestring

The response data containing the result of the operation.

Response

{
  "response": "string"
}

Get VenuesDeprecated

Request

Get all venues by tenant id for upgrading. This method will be removed no sooner than 08/31/2026. The following URL /switchFirmwares/schedules/query can be used for this content.

Security

jwtAuth

Body

required

searchstring

The search term for filtering venues by name or identifier.

firmwareVersionstring

The firmware version to filter venues by their current or target firmware version.

firmwareTypestring

The firmware type to filter venues, such as primary or recovery firmware.

updateAvailableboolean

The flag indicating whether to filter venues that have firmware updates available.

{
  "search": "string",
  "firmwareVersion": "string",
  "firmwareType": "string",
  "updateAvailable": true
}

Responses

Body

idstring

The unique identifier of the venue.

namestring

The name of the venue where firmware upgrades are being managed.

switchFirmwareVersionobject(SwitchVersion)

The firmware version for switches with version numbers below 10.0.0.

switchFirmwareVersionAboveTenobject(SwitchVersion)

The firmware version for switches with version numbers 10.0.0 and above.

availableVersionsArray of objects(SwitchVersion)

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

nextScheduleobject(UpgradeScheduleView)

The next scheduled firmware upgrade for this venue.

lastScheduleUpdateTimestring(date-time)

The timestamp of the last update to the upgrade schedule.

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 that are subject to firmware upgrades.

aboveTenSwitchCountinteger(int32)

The number of switches running firmware version 10.0.0 or above in this venue.

statusstring

The current status of venue wide firmware upgrade operations.

Enum"NONE""INITIATE""SUCCESS""FAILED"

scheduleCountinteger(int32)

The total number of upgrade schedules configured for this venue.

upgradeVenueViewListArray of objects(UpgradeVenue_V1)

The list of upgrade venue views for batch operations or nested venue management.

Response

{
  "id": "string",
  "name": "string",
  "switchFirmwareVersion": {
    "name": "string",
    "category": "RECOMMENDED"
  },
  "switchFirmwareVersionAboveTen": {
    "name": "string",
    "category": "RECOMMENDED"
  },
  "availableVersions": [
    { … }
  ],
  "nextSchedule": {
    "id": "string",
    "timeSlot": { … },
    "version": { … },
    "versionAboveTen": { … }
  },
  "lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
  "preDownload": true,
  "switchCount": 0,
  "aboveTenSwitchCount": 0,
  "status": "NONE",
  "scheduleCount": 0,
  "upgradeVenueViewList": [
    {}
  ]
}

Get VersionsDeprecated

Request

Get different version type of firmware. This method will be removed no sooner than 08/31/2026. The following URL /switchFirmwares/versions/{versionType} can be used for this content.

Security

jwtAuth

Path

versionTypestringrequired

No request payload

Responses

Body

idstring

The identifier

namestring

The firmware version name or number.

categorystring

The category classification of the firmware version.

Enum"RECOMMENDED""CRITICAL""BETA""SOLO"

createdDatestring(date-time)

The date when this firmware version was released or created.

Response

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

Get Current VersionsDeprecated

Request

Get current versions of the venues. This method will be removed no sooner than 08/31/2026. The following URL /switchFirmwares/currentVersions can be used for this content.

Security

jwtAuth

No request payload

Responses

Body

idstring

The identifier

currentVersionsArray of strings

The list of firmware versions currently running on switches with version numbers below 10.0.0 in this venue.

currentVersionsAboveTenArray of strings

The list of firmware versions currently running on switches with version numbers 10.0.0 and above 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

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