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

Query Switch ACLs

Request

Get switch ACLs by query criteria.

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

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
}

Get Switch ACLs

Request

Get all ACLs of the switch.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

No request payload

Responses

Body

Array [

idstring

namestring

The unique name identifier for this switch level access control list.

aclTypestring

The type of access control list configured on this switch, such as IP based or MAC based filtering.

Enum"standard""extended""IPv6"

aclRulesArray of objects(SwitchAclRule_V1_1)unique

The set of ACL rules defined for this switch, specifying the filtering criteria and actions for network traffic on this specific device.

]

Response

[
  {
    "id": "string",
    "name": "string",
    "aclType": "standard",
    "aclRules": [ … ]
  }
]

Get ACL Unions

Request

List all usable ACLs for this switch (the union of venue and device levels).

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

No request payload

Responses

Body

idstring

profileAclArray of strings

The list of ACL names configured at the profile level, applied to multiple switches through profile inheritance.

switchAclArray of strings

The list of ACL names configured directly on the switch, overriding or supplementing profile level configurations.

Response

{
  "id": "string",
  "profileAcl": [
    "string"
  ],
  "switchAcl": [
    "string"
  ]
}

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