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

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

Operations

Switch Firmware Upgrade

Manage firmware upgrade.

Operations

Get Venue Upgrade StatusesDeprecated

Request

Get venue upgrade status by venue id for upgrading.

Security

jwtAuth

Body

required

venueIdstring

{
  "venueId": "string"
}

Responses

Body

idstring

switchIdstring

switchNamestring

statusstring

targetFirmwarestring

switchStatusstring

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

lastStatusUpdateTimestring(date-time)

upgradeStatusDetailsViewListArray of objects(UpgradeStatusDetailsView)

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.

Security

jwtAuth

Body

required

searchstring

venueIdListArray of strings

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

Responses

Body

idstring

venueIdstring

venueNamestring

switchIdstring

switchNamestring

isStackboolean

modelstring

currentFirmwarestring

availableVersionobject(SwitchVersion)

switchNextScheduleobject(UpgradeScheduleView)

venueNextScheduleobject(UpgradeScheduleView)

preDownloadboolean

isSwitchLevelScheduleboolean

upgradeSwitchViewListArray of objects(UpgradeSwitchView)

Response

{
  "id": "string",
  "venueId": "string",
  "venueName": "string",
  "switchId": "string",
  "switchName": "string",
  "isStack": true,
  "model": "string",
  "currentFirmware": "string",
  "availableVersion": {
    "id": "string",
    "tenant": { … },
    "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.

Security

jwtAuth

Body

required

idstring

datestring

timestring

switchVersionstring

switchVersionAboveTenstring

venueIdsArray of strings

switchIdsArray of strings

preDownloadboolean

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

Responses

Body

responsestring

Response

{
  "response": "string"
}

Delete Upgrade ScheduleDeprecated

Request

Cancel the schedule for firmware upgrade.

Security

jwtAuth

Body

required

idstring

venueIdsArray of strings

switchIdsArray of strings

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

Responses

Body

responsestring

Response

{
  "response": "string"
}

Get VenuesDeprecated

Request

Get all venues by tenant id for upgrading.

Security

jwtAuth

Body

required

searchstring

firmwareVersionstring

firmwareTypestring

updateAvailableboolean

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

Responses

Body

idstring

namestring

switchFirmwareVersionobject(SwitchVersion)

switchFirmwareVersionAboveTenobject(SwitchVersion)

availableVersionsArray of objects(SwitchVersion)

nextScheduleobject(UpgradeScheduleView)

lastScheduleUpdateTimestring(date-time)

preDownloadboolean

switchCountinteger(int32)

aboveTenSwitchCountinteger(int32)

statusstring

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

scheduleCountinteger(int32)

upgradeVenueViewListArray of objects(UpgradeVenueView)

Response

{
  "id": "string",
  "name": "string",
  "switchFirmwareVersion": {
    "id": "string",
    "tenant": { … },
    "name": "string",
    "category": "RECOMMENDED"
  },
  "switchFirmwareVersionAboveTen": {
    "id": "string",
    "tenant": { … },
    "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.

Security

jwtAuth

Path

versionTypestringrequired

No request payload

Responses

Body

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 VersionsDeprecated

Request

Get current versions of the venues.

Security

jwtAuth

No request payload

Responses

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

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