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 ACL

Manage ACL (access control list) of switch profile.

Operations

Profile Template

Manage switch profile templates.

Operations

Get Switch Profile TemplatesDeprecated

Request

Get multiple regular switch profile templates or command-line interface profile templates. This method will be removed no sooner than 06/30/2026. The following URL /templates/switchProfiles/{switchProfileId} can be used for this content.

Security

jwtAuth

No request payload

Responses

Body

idstring

namestring

descriptionstring

aclsArray of objects(AclView)unique

vlansArray of objects(Vlan_V1)unique

voiceVlanConfigsArray of objects(VoiceVlanConfigView)unique

trustedPortsArray of objects(TrustedPortView)unique

profileTypestring

Enum"Regular""CLI"

venueCliTemplateobject(AcxVenueCliTemplateView)

venuesArray of stringsunique

venueCountinteger(int64)

templateIdstring

templateVersioninteger(int64)

applyOnboardOnlyboolean

Response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "acls": [
    { … }
  ],
  "vlans": [
    { … }
  ],
  "voiceVlanConfigs": [
    { … }
  ],
  "trustedPorts": [
    { … }
  ],
  "profileType": "Regular",
  "venueCliTemplate": {
    "id": "string",
    "name": "string",
    "cli": "string",
    "switchModels": "string",
    "variables": [ … ],
    "overwrite": true
  },
  "venues": [
    "string"
  ],
  "venueCount": 0,
  "templateId": "string",
  "templateVersion": 0,
  "applyOnboardOnly": true
}

Delete Switch Profile TemplatesDeprecated

Request

Delete multiple regular switch profile templates or command-line interface profile templates. This method will be removed no sooner than 06/30/2026. The following URL /templates/switchProfiles/{switchProfileId} can be used for this content.

Security

jwtAuth

Body

requiredArray [

string

]

[
  "string"
]

Responses

Body

requestIdstring

responseobject(EmptyView)

Response

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

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

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