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

Associate Command-Line Interface Templates to Switches

Request

Associate command-line interface templates to switches.

Security
jwtAuth
Path
venueIdstringrequired
cliTemplateIdstringrequired
Bodyapplication/jsonrequiredArray [
string
]
application/json
[
  "string"
]

Responses

Accepted

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Disassociate Command-Line Interface Templates to Switches

Request

Disassociate command-line interface templates to switches.

Security
jwtAuth
Path
venueIdstringrequired
cliTemplateIdstringrequired
Bodyapplication/jsonrequiredArray [
string
]
application/json
[
  "string"
]

Responses

Accepted

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Get Command-Line Interface Template

Request

Get a command-line interface template by id.

Security
jwtAuth
Path
cliTemplateIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring^.{1,64}$
clistring
variablesArray of objects(CliTemplateVariableBo)unique
reloadboolean
applyLaterboolean
venueSwitchesArray of objects(AcxCliTemplateSwitchesView)
Response
{
  "id": "string",
  "name": "string",
  "cli": "string",
  "variables": [
    { … }
  ],
  "reload": true,
  "applyLater": true,
  "venueSwitches": [
    { … }
  ]
}

Update Command-Line Interface Template

Request

Update a command-line interface template for switches by id.

Security
jwtAuth
Path
cliTemplateIdstringrequired
Body
required
applyLaterboolean
clistring
idstring
namestring^.{1,64}$
reloadboolean
variablesArray of objects(AcxCliTemplateVariableBo)unique
venueSwitchesArray of objects(VenueSwitchBo)
{
  "applyLater": true,
  "cli": "string",
  "id": "string",
  "name": "string",
  "reload": true,
  "variables": [
    { … }
  ],
  "venueSwitches": [
    { … }
  ]
}

Responses

OK

Body
idstring
namestring^.{1,64}$
clistring
variablesArray of objects(CliTemplateVariableBo)unique
reloadboolean
applyLaterboolean
venueSwitchesArray of objects(AcxCliTemplateSwitchesView)
Response
{
  "id": "string",
  "name": "string",
  "cli": "string",
  "variables": [
    { … }
  ],
  "reload": true,
  "applyLater": true,
  "venueSwitches": [
    { … }
  ]
}

Delete Command-Line Interface Template

Request

Delete a command-line interface template by id.

Security
jwtAuth
Path
cliTemplateIdstringrequired
No request payload

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Add Command-Line Interface Template

Request

Create a command-line interface template for switches.

Security
jwtAuth
Body
required
applyLaterboolean
clistring
idstring
namestring^.{1,64}$
reloadboolean
variablesArray of objects(AcxCliTemplateVariableBo)unique
venueSwitchesArray of objects(VenueSwitchBo)
{
  "applyLater": true,
  "cli": "string",
  "id": "string",
  "name": "string",
  "reload": true,
  "variables": [
    { … }
  ],
  "venueSwitches": [
    { … }
  ]
}

Responses

OK

Body
idstring
namestring^.{1,64}$
clistring
variablesArray of objects(CliTemplateVariableBo)unique
reloadboolean
applyLaterboolean
venueSwitchesArray of objects(AcxCliTemplateSwitchesView)
Response
{
  "id": "string",
  "name": "string",
  "cli": "string",
  "variables": [
    { … }
  ],
  "reload": true,
  "applyLater": true,
  "venueSwitches": [
    { … }
  ]
}

Delete Command-Line Interface Templates

Request

Delete command-line interface templates.

Security
jwtAuth
Body
requiredArray [
string
]
[
  "string"
]

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Query Command-Line Interface Templates

Request

Get a list of command-line interface templates by query.

Security
jwtAuth
Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
filtersobject
searchStringstring
searchTargetFieldsArray of strings
filterTypestringDeprecated
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "filterType": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ]
}

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 Command-Line Interface Template-Examples

Request

Get a list of command-line interface template examples.

Security
jwtAuth
Query
categorystring
No request payload

Responses

OK

Body
idstring
clistring
namestring
versionstring
Response
{
  "id": "string",
  "cli": "string",
  "name": "string",
  "version": "string"
}

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

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