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

Associate Command Line Interface Templates

Request

Associate command line interface templates to switches.

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

Responses

Accepted

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"
  }
}

Disassociate Command Line Interface Templates

Request

Disassociate command line interface templates to switches.

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

Responses

Accepted

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"
  }
}

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

The identifier

namestring^.{1,64}$

The unique name identifier for this CLI template, limited to 64 characters.

clistring

The CLI command template content containing switch configuration commands and variable placeholders.

variablesArray of objects(CliTemplateVariableBo)unique

The set of variables defined in this CLI template for dynamic configuration value substitution.

reloadboolean

The flag indicating whether the switch should be reloaded after applying this CLI template.

applyLaterboolean

The flag indicating whether to apply this CLI template later rather than immediately.

venueSwitchesArray of objects(AcxCliTemplateSwitches_V1)

The list of venue switch associations indicating which switches in each venue should receive this CLI template.

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

Flag indicating whether to apply the CLI template later rather than immediately (default: false).

clistring

The CLI command template content with variable placeholders (e.g., {{variable_name}}).

idstring

Unique identifier for the CLI template.

namestring^.{1,64}$

Name of the CLI template (1-64 characters).

reloadboolean

Flag indicating whether to reload the switch after applying the CLI commands (default: false).

variablesArray of objects(AcxCliTemplateVariableBo)unique

Set of template variables that can be customized for each switch when applying the CLI template.

venueSwitchesArray of objects(VenueSwitchBo)

List of venue switches to which this CLI template will be applied.

{
  "applyLater": true,
  "cli": "string",
  "id": "string",
  "name": "string",
  "reload": true,
  "variables": [
    { … }
  ],
  "venueSwitches": [
    { … }
  ]
}

Responses

OK

Body
idstring

The identifier

namestring^.{1,64}$

The unique name identifier for this CLI template, limited to 64 characters.

clistring

The CLI command template content containing switch configuration commands and variable placeholders.

variablesArray of objects(CliTemplateVariableBo)unique

The set of variables defined in this CLI template for dynamic configuration value substitution.

reloadboolean

The flag indicating whether the switch should be reloaded after applying this CLI template.

applyLaterboolean

The flag indicating whether to apply this CLI template later rather than immediately.

venueSwitchesArray of objects(AcxCliTemplateSwitches_V1)

The list of venue switch associations indicating which switches in each venue should receive this CLI template.

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

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

Request

Create a command line interface template for switches.

Security
jwtAuth
Body
required
applyLaterboolean

Flag indicating whether to apply the CLI template later rather than immediately (default: false).

clistring

The CLI command template content with variable placeholders (e.g., {{variable_name}}).

idstring

Unique identifier for the CLI template.

namestring^.{1,64}$

Name of the CLI template (1-64 characters).

reloadboolean

Flag indicating whether to reload the switch after applying the CLI commands (default: false).

variablesArray of objects(AcxCliTemplateVariableBo)unique

Set of template variables that can be customized for each switch when applying the CLI template.

venueSwitchesArray of objects(VenueSwitchBo)

List of venue switches to which this CLI template will be applied.

{
  "applyLater": true,
  "cli": "string",
  "id": "string",
  "name": "string",
  "reload": true,
  "variables": [
    { … }
  ],
  "venueSwitches": [
    { … }
  ]
}

Responses

OK

Body
idstring

The identifier

namestring^.{1,64}$

The unique name identifier for this CLI template, limited to 64 characters.

clistring

The CLI command template content containing switch configuration commands and variable placeholders.

variablesArray of objects(CliTemplateVariableBo)unique

The set of variables defined in this CLI template for dynamic configuration value substitution.

reloadboolean

The flag indicating whether the switch should be reloaded after applying this CLI template.

applyLaterboolean

The flag indicating whether to apply this CLI template later rather than immediately.

venueSwitchesArray of objects(AcxCliTemplateSwitches_V1)

The list of venue switch associations indicating which switches in each venue should receive this CLI template.

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

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 Command Line Interface Templates

Request

Get a list of command line interface templates by query.

Security
jwtAuth
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"
filtersobject

The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.

searchStringstring

The search string for full text search across the specified target fields.

searchTargetFieldsArray of strings

The list of field names to search within when applying the search string.

filterTypestringDeprecated

The dynamic filter type (deprecated, use filters instead).

{
  "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

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 Examples

Request

Get a list of command line interface template examples.

Security
jwtAuth
Query
categorystring
No request payload

Responses

OK

Body
idstring

The identifier

clistring

The CLI command template text containing configuration commands for switch management.

namestring

The name of the CLI template sample for identification and reference.

versionstring

The firmware version or compatibility version for which this CLI template is designed.

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