Skip to content
/
Create Upgrade Schedule

Switch Service API & Model Documentation (0.3.4)

Overview

Rate Limit

For the Switch REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 20 calls can be made per second.
  • Each second 10 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Terms of Service

Languages
Servers
Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.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 configuration history.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX Switches.

Operations

Import Switch

Import Switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles.

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 configuration backups.

Operations

Switch Firmware Upgrade

Manage firmware upgrade.

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
Bodyapplication/vnd.ruckus.v1.1+jsonrequired
idstring
datestring
timestring
versionsArray of objects(ModelVersionViewV1001)unique
switchIdsArray of strings
preDownloadboolean
application/vnd.ruckus.v1.1+json
{
  "id": "string",
  "date": "string",
  "time": "string",
  "versions": [
    { … }
  ],
  "switchIds": [
    "string"
  ],
  "preDownload": true
}

Responses

OK

Bodyapplication/vnd.ruckus.v1.1+json
requestIdstring
responseobject(EmptyView)
Response
application/vnd.ruckus.v1.1+json
{
  "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
Body
required
idstring
datestring
timestring
switchVersionstring
switchVersionAboveTenstring
switchIdsArray of strings
preDownloadboolean
{
  "id": "string",
  "date": "string",
  "time": "string",
  "switchVersion": "string",
  "switchVersionAboveTen": "string",
  "switchIds": [
    "string"
  ],
  "preDownload": true
}

Responses

Created

Body
requestIdstring
responseobject(EmptyView)
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
{
  "id": "string",
  "switchIds": [
    "string"
  ]
}

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Get Switches

Request

Get all switches by tenant id for upgrading.

Security
jwtAuth
Body
required
searchFilterstring
venueIdListArray of strings
{
  "searchFilter": "string",
  "venueIdList": [
    "string"
  ]
}

Responses

OK

Body
Array [
idstring
venueIdstring
venueNamestring
switchIdstring
switchNamestring
isStackboolean
modelstring
currentFirmwarestring
availableVersionobject(SwitchVersionViewV1000)
switchNextScheduleobject(UpgradeScheduleViewV1000)
venueNextScheduleobject(UpgradeScheduleViewV1000)
preDownloadboolean
isSwitchLevelScheduleboolean
]
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
firmwareVersionstring
{
  "searchFilter": "string",
  "firmwareVersion": "string"
}

Responses

OK

Body
Array [
idstring
venueIdstring
venueNamestring
switchFirmwareVersionobject(SwitchVersionViewV1000)
switchFirmwareVersionAboveTenobject(SwitchVersionViewV1000)
availableVersionsArray of objects(SwitchVersionViewV1000)
nextScheduleobject(UpgradeScheduleViewV1000)
lastScheduleUpdateTimestring(date-time)
preDownloadboolean
switchCountinteger(int32)
aboveTenSwitchCountinteger(int32)
statusstring
Enum"NONE""INITIATE""SUCCESS""FAILED"
scheduleCountinteger(int32)
]
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
categorystring
Enum"RECOMMENDED""CRITICAL""BETA""SOLO"
createdDatestring(date-time)
]
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
currentVersionsAboveTenArray of strings
Response
{
  "id": "string",
  "currentVersions": [
    "string"
  ],
  "currentVersionsAboveTen": [
    "string"
  ]
}

Switch Ports

Manage Ports.

Operations

Switch Static Routes

Manage static routes.

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