Skip to content

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

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

Retrieve Venue Template AAA Setting

Request

Retrieve venue template's authentication, authorization, and accounting setting.

Security
jwtAuth
Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring
authnEnabledSshboolean

Indicates whether AAA authentication is enabled for SSH access to the switch.

authnFirstPrefstring

The first preference method for authentication, specifying the primary authentication mechanism to be used.

authnSecondPrefstring

The second preference method for authentication, used as a fallback if the first method fails.

authnThirdPrefstring

The third preference method for authentication, used as a fallback if the second method fails.

authnFourthPrefstring

The fourth preference method for authentication, used as the final fallback option.

authzEnabledCommandboolean

Indicates whether authorization is enabled for command execution on the switch.

authzEnabledExecboolean

Indicates whether authorization is enabled for EXEC mode access on the switch.

authzCommonsLevelstring

The authorization level for common commands, determining the privilege level required.

authzCommonsFirstServerstring

The first server to be consulted for common command authorization.

authzCommonsSecondServerstring

The second server to be consulted for common command authorization if the first server is unavailable.

authzCommonsThirdServerstring

The third server to be consulted for common command authorization if the first two servers are unavailable.

authzExecFirstServerstring

The first server to be consulted for EXEC mode authorization.

authzExecSecondServerstring

The second server to be consulted for EXEC mode authorization if the first server is unavailable.

authzExecThirdServerstring

The third server to be consulted for EXEC mode authorization if the first two servers are unavailable.

acctEnabledCommandboolean

Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.

acctEnabledExecboolean

Indicates whether accounting is enabled for EXEC mode sessions, tracking user login sessions for auditing purposes.

acctCommonsLevelstring

The accounting level for common commands, determining which commands are logged.

acctCommonsFirstServerstring

The first server to receive accounting records for common commands.

acctCommonsSecondServerstring

The second server to receive accounting records for common commands if the first server is unavailable.

acctCommonsThirdServerstring

The third server to receive accounting records for common commands if the first two servers are unavailable.

acctExecFirstServerstring

The first server to receive accounting records for EXEC mode sessions.

acctExecSecondServerstring

The second server to receive accounting records for EXEC mode sessions if the first server is unavailable.

acctExecThirdServerstring

The third server to receive accounting records for EXEC mode sessions if the first two servers are unavailable.

Response
{
  "id": "string",
  "authnEnabledSsh": true,
  "authnFirstPref": "string",
  "authnSecondPref": "string",
  "authnThirdPref": "string",
  "authnFourthPref": "string",
  "authzEnabledCommand": true,
  "authzEnabledExec": true,
  "authzCommonsLevel": "string",
  "authzCommonsFirstServer": "string",
  "authzCommonsSecondServer": "string",
  "authzCommonsThirdServer": "string",
  "authzExecFirstServer": "string",
  "authzExecSecondServer": "string",
  "authzExecThirdServer": "string",
  "acctEnabledCommand": true,
  "acctEnabledExec": true,
  "acctCommonsLevel": "string",
  "acctCommonsFirstServer": "string",
  "acctCommonsSecondServer": "string",
  "acctCommonsThirdServer": "string",
  "acctExecFirstServer": "string",
  "acctExecSecondServer": "string",
  "acctExecThirdServer": "string"
}

Update Venue Template AAA Setting

Request

Update venue template's authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update. Add Prefix '/rec' for REC Templates.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
idstring
authnEnabledSshboolean

Indicates whether AAA authentication is enabled for SSH access to the switch.

authnFirstPrefstring

The first preference method for authentication, specifying the primary authentication mechanism to be used.

authnSecondPrefstring

The second preference method for authentication, used as a fallback if the first method fails.

authnThirdPrefstring

The third preference method for authentication, used as a fallback if the second method fails.

authnFourthPrefstring

The fourth preference method for authentication, used as the final fallback option.

authzEnabledCommandboolean

Indicates whether authorization is enabled for command execution on the switch.

authzEnabledExecboolean

Indicates whether authorization is enabled for EXEC mode access on the switch.

authzCommonsLevelstring

The authorization level for common commands, determining the privilege level required.

authzCommonsFirstServerstring

The first server to be consulted for common command authorization.

authzCommonsSecondServerstring

The second server to be consulted for common command authorization if the first server is unavailable.

authzCommonsThirdServerstring

The third server to be consulted for common command authorization if the first two servers are unavailable.

authzExecFirstServerstring

The first server to be consulted for EXEC mode authorization.

authzExecSecondServerstring

The second server to be consulted for EXEC mode authorization if the first server is unavailable.

authzExecThirdServerstring

The third server to be consulted for EXEC mode authorization if the first two servers are unavailable.

acctEnabledCommandboolean

Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.

acctEnabledExecboolean

Indicates whether accounting is enabled for EXEC mode sessions, tracking user login sessions for auditing purposes.

acctCommonsLevelstring

The accounting level for common commands, determining which commands are logged.

acctCommonsFirstServerstring

The first server to receive accounting records for common commands.

acctCommonsSecondServerstring

The second server to receive accounting records for common commands if the first server is unavailable.

acctCommonsThirdServerstring

The third server to receive accounting records for common commands if the first two servers are unavailable.

acctExecFirstServerstring

The first server to receive accounting records for EXEC mode sessions.

acctExecSecondServerstring

The second server to receive accounting records for EXEC mode sessions if the first server is unavailable.

acctExecThirdServerstring

The third server to receive accounting records for EXEC mode sessions if the first two servers are unavailable.

{
  "id": "string",
  "authnEnabledSsh": true,
  "authnFirstPref": "string",
  "authnSecondPref": "string",
  "authnThirdPref": "string",
  "authnFourthPref": "string",
  "authzEnabledCommand": true,
  "authzEnabledExec": true,
  "authzCommonsLevel": "string",
  "authzCommonsFirstServer": "string",
  "authzCommonsSecondServer": "string",
  "authzCommonsThirdServer": "string",
  "authzExecFirstServer": "string",
  "authzExecSecondServer": "string",
  "authzExecThirdServer": "string",
  "acctEnabledCommand": true,
  "acctEnabledExec": true,
  "acctCommonsLevel": "string",
  "acctCommonsFirstServer": "string",
  "acctCommonsSecondServer": "string",
  "acctCommonsThirdServer": "string",
  "acctExecFirstServer": "string",
  "acctExecSecondServer": "string",
  "acctExecThirdServer": "string"
}

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(AaaSetting_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "authnEnabledSsh": true,
    "authnFirstPref": "string",
    "authnSecondPref": "string",
    "authnThirdPref": "string",
    "authnFourthPref": "string",
    "authzEnabledCommand": true,
    "authzEnabledExec": true,
    "authzCommonsLevel": "string",
    "authzCommonsFirstServer": "string",
    "authzCommonsSecondServer": "string",
    "authzCommonsThirdServer": "string",
    "authzExecFirstServer": "string",
    "authzExecSecondServer": "string",
    "authzExecThirdServer": "string",
    "acctEnabledCommand": true,
    "acctEnabledExec": true,
    "acctCommonsLevel": "string",
    "acctCommonsFirstServer": "string",
    "acctCommonsSecondServer": "string",
    "acctCommonsThirdServer": "string",
    "acctExecFirstServer": "string",
    "acctExecSecondServer": "string",
    "acctExecThirdServer": "string"
  }
}

Venue Template Switch Setting

Manage switch settings of venue template.

Operations

Web Authentication Page Template

Manage web authentication page template.

Operations