Skip to content
Switch Services/
/
Retrieve Venue Template A...

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

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

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