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

The identifier

namestring

The name of the venue representing a physical location or site in the network infrastructure.

dnsArray of strings

The list of DNS server IP addresses configured for name resolution at the venue level.

switchLoginUsernamestring

The username credential for logging into switches in this venue.

switchLoginPasswordstring

The password credential for logging into switches in this venue.

syslogEnabledboolean

The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.

syslogPrimaryServerstring

The IP address of the primary syslog server for receiving log messages from switches in this venue.

syslogSecondaryServerstring

The IP address of the secondary syslog server for redundant log message reception.

cliAppliedboolean

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

profileIdArray of stringsunique

The set of profile identifiers associated with this venue for switch configuration management.

switchProfileIdsArray of stringsunique

The set of switch specific profile identifiers applied to switches in this venue.

switchCliProfileIdsArray of stringsunique

The set of CLI profile identifiers applied to switches in this venue.

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

Unique identifier for the venue.

dnsArray of strings

List of DNS server IP addresses for switches in this venue.

syslogEnabledboolean

Enable syslog for centralized logging (default: false).

syslogPrimaryServerstring

Primary syslog server IP address or hostname.

syslogSecondaryServerstring

Secondary syslog server IP address or hostname for redundancy.

profileIdArray of strings

List of profile identifiers to be associated with this venue.

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

Responses

Body

idstring

The identifier

namestring

The name of the venue representing a physical location or site in the network infrastructure.

dnsArray of strings

The list of DNS server IP addresses configured for name resolution at the venue level.

switchLoginUsernamestring

The username credential for logging into switches in this venue.

switchLoginPasswordstring

The password credential for logging into switches in this venue.

syslogEnabledboolean

The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.

syslogPrimaryServerstring

The IP address of the primary syslog server for receiving log messages from switches in this venue.

syslogSecondaryServerstring

The IP address of the secondary syslog server for redundant log message reception.

cliAppliedboolean

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

profileIdArray of stringsunique

The set of profile identifiers associated with this venue for switch configuration management.

switchProfileIdsArray of stringsunique

The set of switch specific profile identifiers applied to switches in this venue.

switchCliProfileIdsArray of stringsunique

The set of CLI profile identifiers applied to switches in this venue.

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