Skip to content
Switch Services/
/
Update Venue Template Swi...

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

Venue Template Switch Setting

Manage switch settings of venue template.

Operations

Get Venue Template Switch Setting

Request

Get the switch settings of the venue template.

Security
jwtAuth
Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring

The unique name of the venue template.

dnsArray of strings

The list of DNS server IP addresses configured for this venue template.

syslogEnabledboolean

The flag indicating whether syslog functionality is enabled for this venue template.

syslogPrimaryServerstring

The IP address or hostname of the primary syslog server for log collection.

syslogSecondaryServerstring

The IP address or hostname of the secondary syslog server for redundancy.

cliAppliedboolean

The flag indicating whether CLI templates have been applied to switches in this venue.

profileIdArray of stringsunique

The set of port profile identifiers associated with this venue template.

switchProfileIdsArray of stringsunique

The set of switch profile identifiers that are applied at the venue level.

switchCliProfileIdsArray of stringsunique

The set of CLI profile identifiers for switch command line interface configuration.

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

Update Venue Template Switch Setting

Request

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

Security
jwtAuth
Path
venueIdstringrequired
Body
required
idstring
syslogEnabledboolean

Enable syslog for centralized logging of switches in venues using this template (default: false).

syslogPrimaryServerstring

Primary syslog server IP address or hostname for the template.

syslogSecondaryServerstring

Secondary syslog server IP address or hostname for redundancy in the template.

dnsArray of strings

List of DNS server IP addresses for switches in venues using this template.

profileIdArray of stringsunique

Set of profile identifiers associated with this venue template.

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

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(Venue_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "name": "string",
    "dns": [ … ],
    "syslogEnabled": true,
    "syslogPrimaryServer": "string",
    "syslogSecondaryServer": "string",
    "cliApplied": true,
    "profileId": [ … ]
  }
}

Web Authentication Page Template

Manage web authentication page template.

Operations