Switch Service API & Model Documentation (0.4.0)

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

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

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

Get Venue Switch Setting

Request

Get the switch settings of the venue.

Security

jwtAuth

Path

venueIdstringrequired

No request payload

Responses

Body

idstring

namestring

dnsArray of strings

switchLoginUsernamestring

switchLoginPasswordstring

syslogEnabledboolean

syslogPrimaryServerstring

syslogSecondaryServerstring

cliAppliedboolean

profileIdArray of stringsunique

switchProfileIdsArray of stringsunique

switchCliProfileIdsArray of stringsunique

Response

{
  "id": "string",
  "name": "string",
  "dns": [
    "string"
  ],
  "switchLoginUsername": "string",
  "switchLoginPassword": "string",
  "syslogEnabled": true,
  "syslogPrimaryServer": "string",
  "syslogSecondaryServer": "string",
  "cliApplied": true,
  "profileId": [
    "string"
  ],
  "switchProfileIds": [
    "string"
  ],
  "switchCliProfileIds": [
    "string"
  ]
}

Update Venue Switch Setting

Request

Update the switch settings of the venue. Use activity API with request id to get the status update.

Security

jwtAuth

Path

venueIdstringrequired

Body

required

idstring

dnsArray of strings

syslogEnabledboolean

syslogPrimaryServerstring

syslogSecondaryServerstring

profileIdArray of strings

{
  "id": "string",
  "dns": [
    "string"
  ],
  "syslogEnabled": true,
  "syslogPrimaryServer": "string",
  "syslogSecondaryServer": "string",
  "profileId": [
    "string"
  ]
}

Responses

Body

idstring

namestring

dnsArray of strings

switchLoginUsernamestring

switchLoginPasswordstring

syslogEnabledboolean

syslogPrimaryServerstring

syslogSecondaryServerstring

cliAppliedboolean

profileIdArray of stringsunique

switchProfileIdsArray of stringsunique

switchCliProfileIdsArray of stringsunique

Response

{
  "id": "string",
  "name": "string",
  "dns": [
    "string"
  ],
  "switchLoginUsername": "string",
  "switchLoginPassword": "string",
  "syslogEnabled": true,
  "syslogPrimaryServer": "string",
  "syslogSecondaryServer": "string",
  "cliApplied": true,
  "profileId": [
    "string"
  ],
  "switchProfileIds": [
    "string"
  ],
  "switchCliProfileIds": [
    "string"
  ]
}

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