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

Get DHCP Server Setting

Request

Get switch's DHCP server setting.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
dhcpServerIdstringrequired
No request payload

Responses

OK

Body
idstring
poolNamestring

The name of the DHCP address pool.

defaultRouterIpstring

The default gateway IP address provided to DHCP clients.

excludedEndstring

The ending IP address of the excluded address range that will not be assigned to clients.

excludedStartstring

The starting IP address of the excluded address range that will not be assigned to clients.

leaseDaysinteger(int32)

The number of days in the DHCP lease duration.

leaseHrsinteger(int32)

The number of hours in the DHCP lease duration.

leaseMinsinteger(int32)

The number of minutes in the DHCP lease duration.

dhcpOptionsArray of objects(DhcpOption_V1_1)

The list of additional DHCP options to be provided to clients.

subnetAddressstring

The subnet network address for the DHCP pool.

subnetMaskstring

The subnet mask for the DHCP network.

Response
{
  "id": "string",
  "poolName": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string"
}

Update DHCP Server Setting

Request

Update switch's DHCP server setting.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
dhcpServerIdstringrequired
Body
required
idstring
poolNamestring

The name of the DHCP address pool.

defaultRouterIpstring

The default gateway IP address provided to DHCP clients.

excludedEndstring

The ending IP address of the excluded address range that will not be assigned to clients.

excludedStartstring

The starting IP address of the excluded address range that will not be assigned to clients.

leaseDaysinteger(int32)

The number of days in the DHCP lease duration.

leaseHrsinteger(int32)

The number of hours in the DHCP lease duration.

leaseMinsinteger(int32)

The number of minutes in the DHCP lease duration.

dhcpOptionsArray of objects(DhcpOption_V1_1)

The list of additional DHCP options to be provided to clients.

subnetAddressstring

The subnet network address for the DHCP pool.

subnetMaskstring

The subnet mask for the DHCP network.

{
  "id": "string",
  "poolName": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string"
}

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(DhcpServer_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "poolName": "string",
    "defaultRouterIp": "string",
    "excludedEnd": "string",
    "excludedStart": "string",
    "leaseDays": 0,
    "leaseHrs": 0,
    "leaseMins": 0,
    "dhcpOptions": [ … ],
    "subnetAddress": "string",
    "subnetMask": "string"
  }
}

Delete DHCP Server Setting

Request

Delete switch's DHCP server setting.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
dhcpServerIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Add DHCP Server

Request

Add switch's DHCP server settings. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
idstring
poolNamestring

The name of the DHCP address pool.

defaultRouterIpstring

The default gateway IP address provided to DHCP clients.

excludedEndstring

The ending IP address of the excluded address range that will not be assigned to clients.

excludedStartstring

The starting IP address of the excluded address range that will not be assigned to clients.

leaseDaysinteger(int32)

The number of days in the DHCP lease duration.

leaseHrsinteger(int32)

The number of hours in the DHCP lease duration.

leaseMinsinteger(int32)

The number of minutes in the DHCP lease duration.

dhcpOptionsArray of objects(DhcpOption_V1_1)

The list of additional DHCP options to be provided to clients.

subnetAddressstring

The subnet network address for the DHCP pool.

subnetMaskstring

The subnet mask for the DHCP network.

{
  "id": "string",
  "poolName": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string"
}

Responses

Created

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(DhcpServer_V1_1)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "poolName": "string",
    "defaultRouterIp": "string",
    "excludedEnd": "string",
    "excludedStart": "string",
    "leaseDays": 0,
    "leaseHrs": 0,
    "leaseMins": 0,
    "dhcpOptions": [ … ],
    "subnetAddress": "string",
    "subnetMask": "string"
  }
}

Delete DHCP Servers

Request

Delete switch's DHCP servers.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
requiredArray [
string
]
[
  "string"
]

Responses

No Content

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Query DHCP Servers

Request

List of ICX DHCP servers.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
fieldsArray of strings

The list of field names to include in the query response, allowing clients to request only specific fields.

pageinteger(int32)

The page number for pagination, starting from 1, defaulting to 1.

pageSizeinteger(int32)

The number of records to return per page, defaulting to 25.

sortFieldstring

The field name to use for sorting the query results.

sortOrderstring

The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Enum"ASC""DESC"
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC"
}

Responses

OK

Body
idstring
dataArray of objects

The list of data records returned by the query, with each item representing a result object.

fieldsArray of strings

The list of field names included in the query response data.

pageinteger(int32)

The current page number of the paginated results.

totalCountinteger(int64)

The total number of records matching the query criteria across all pages.

totalPagesinteger(int32)

The total number of pages available based on the page size and total record count.

Response
{
  "id": "string",
  "data": [
    null
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Change Switch DHCP Server State

Request

Change switch's DHCP server state. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
stateboolean

The operational state of the DHCP server, where true indicates enabled and false indicates disabled.

{
  "state": true
}

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

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

Venue Template Switch Setting

Manage switch settings of venue template.

Operations

Web Authentication Page Template

Manage web authentication page template.

Operations