Skip to content

Switch Service API & Model Documentation (0.3.4)

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

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.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 ACL

Manage ACL (access control list) of switch profile.

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

Retrieve ACLsDeprecated

Request

Query the switch's switch-level ACLs.

Security
jwtAuth
Path
switchIdstringrequired
Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC"
}

Responses

OK

Body
idstring
dataArray of objects
fieldsArray of strings
pageinteger(int32)
totalCountinteger(int64)
totalPagesinteger(int32)
Response
{
  "id": "string",
  "data": [
    {}
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Get ACLsDeprecated

Request

Get all ACLs of the switch.

Security
jwtAuth
Path
switchIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring
aclTypestring
Enum"standard""extended""IPv6"
aclRulesArray of objects(AclRuleView)unique
aclViewListArray of objects(AclView)
Response
{
  "id": "string",
  "name": "string",
  "aclType": "standard",
  "aclRules": [
    { … }
  ],
  "aclViewList": [
    {}
  ]
}

Get ACL UnionDeprecated

Request

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

Security
jwtAuth
Path
switchIdstringrequired
No request payload

Responses

OK

Body
profileAclArray of strings
switchAclArray of strings
Response
{
  "profileAcl": [
    "string"
  ],
  "switchAcl": [
    "string"
  ]
}

Get ACLDeprecated

Request

Get the ACL of the switch.

Security
jwtAuth
Path
aclIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring
aclTypestring
Enum"standard""extended""IPv6"
aclRulesArray of objects(AclRuleView)unique
aclViewListArray of objects(AclView)
Response
{
  "id": "string",
  "name": "string",
  "aclType": "standard",
  "aclRules": [
    { … }
  ],
  "aclViewList": [
    {}
  ]
}

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

Trusted Port

Manage a port's trust 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