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

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

Associate Switch Profile to Venue

Request

Associate a switch profile to a venue.

Security
jwtAuth
Path
venueIdstringrequired
switchProfileIdstringrequired
No request payload

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 Switch Profile to Venue

Request

Disassociate a switch profile to a venue.

Security
jwtAuth
Path
venueIdstringrequired
switchProfileIdstringrequired
No request payload

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 Switch Profile

Request

Get a regular switch profile or command line interface profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

namestring

The name of the configuration profile for identification and reference.

descriptionstring

The detailed description explaining the purpose and contents of this configuration profile.

aclsArray of objects(Acl_V1)unique

The set of Access Control List configurations included in this profile for traffic filtering.

vlansArray of objects(Vlan_V1)unique

The ordered set of VLAN configurations included in this profile with Layer 2 security features.

voiceVlanConfigsArray of objects(VoiceVlanConfig_V1)unique

The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.

trustedPortsArray of objects(TrustedPort_V1)unique

The set of trusted port configurations for DHCP snooping and ARP inspection security features.

profileTypestring

The type of profile indicating its scope: global, venue specific, or template based.

Enum"Regular""CLI"
venueCliTemplateobject(AcxVenueCliTemplateView)

The CLI template configuration associated with this profile for custom command execution.

venuesArray of stringsunique

The set of venue identifiers where this profile is deployed or available for use.

venueCountinteger(int64)

The total number of venues where this profile is currently deployed.

templateIdstring

The identifier of the profile template used as the basis for this profile configuration.

templateVersioninteger(int64)

The version number of the profile template.

applyOnboardOnlyboolean

The flag indicating whether this profile should only be applied during switch onboarding.

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
}

Update Switch Profile

Request

Update a regular switch profile or command line interface profile. Use activity API with request id to get the status update.

Security
jwtAuth
Path
switchProfileIdstringrequired
Body
required
namestring^.{1,64}$

Profile name (1-64 characters).

descriptionstring

Profile description providing additional details about the configuration purpose.

venuesArray of strings

List of venue identifiers where this profile is applied.

idstring

Unique identifier for the profile.

aclsArray of objects(AclBo_V1)unique

Set of ACL (Access Control List) configurations included in this profile.

profileTypestring

Profile type (Regular, CLI)

Enum"Regular""CLI"
vlansArray of objects(VlanBo)unique

Set of VLAN configurations included in this profile.

voiceVlanConfigsArray of objects(VoiceVlanConfigBo)unique

Set of voice VLAN configurations for IP phones and voice devices.

trustedPortsArray of objects(TrustedPortBo)unique

Set of trusted port configurations for QoS and security settings.

venueCliTemplateobject(AcxVenueCliTemplateBo_V1)

Venue level CLI template configuration for applying custom CLI commands across multiple switches in a venue. Deprecated, this version, application/vnd.ruckus.v1+json will be removed no sooner than 06/30/2026.

isTemplateboolean

Flag indicating whether this profile is a template that can be used to create other profiles (default: false).

templateIdstring

Identifier of the template that this profile was created from (if applicable).

templateVersioninteger(int64)

Version number of the template being used.

applyOnboardOnlyboolean

Flag indicating whether this profile should only be applied during switch onboarding.

portProfileMappingsArray of objects(PortProfileAndProfileMappingBo)unique

Set of mappings between port profiles and this configuration profile.

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

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

Delete Switch Profile

Request

Delete a regular switch profile or command line interface profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
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 Switch Profile

Request

Add a regular switch profile or command line interface profile. Use activity API with request id to get the status update.

Security
jwtAuth
Body
required
namestring^.{1,64}$

Profile name (1-64 characters).

descriptionstring

Profile description providing additional details about the configuration purpose.

venuesArray of strings

List of venue identifiers where this profile is applied.

idstring

Unique identifier for the profile.

aclsArray of objects(AclBo_V1)unique

Set of ACL (Access Control List) configurations included in this profile.

profileTypestring

Profile type (Regular, CLI)

Enum"Regular""CLI"
vlansArray of objects(VlanBo)unique

Set of VLAN configurations included in this profile.

voiceVlanConfigsArray of objects(VoiceVlanConfigBo)unique

Set of voice VLAN configurations for IP phones and voice devices.

trustedPortsArray of objects(TrustedPortBo)unique

Set of trusted port configurations for QoS and security settings.

venueCliTemplateobject(AcxVenueCliTemplateBo_V1)

Venue level CLI template configuration for applying custom CLI commands across multiple switches in a venue. Deprecated, this version, application/vnd.ruckus.v1+json will be removed no sooner than 06/30/2026.

isTemplateboolean

Flag indicating whether this profile is a template that can be used to create other profiles (default: false).

templateIdstring

Identifier of the template that this profile was created from (if applicable).

templateVersioninteger(int64)

Version number of the template being used.

applyOnboardOnlyboolean

Flag indicating whether this profile should only be applied during switch onboarding.

portProfileMappingsArray of objects(PortProfileAndProfileMappingBo)unique

Set of mappings between port profiles and this configuration profile.

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

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 Switch Profiles

Request

List the regular switch profiles or command line interface profiles.

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 Switch Profiles

Request

Get regular switch profiles or command line interface profiles of the venue.

Security
jwtAuth
Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

namestring

The name of the configuration profile for identification and reference.

descriptionstring

The detailed description explaining the purpose and contents of this configuration profile.

aclsArray of objects(Acl_V1)unique

The set of Access Control List configurations included in this profile for traffic filtering.

vlansArray of objects(Vlan_V1)unique

The ordered set of VLAN configurations included in this profile with Layer 2 security features.

voiceVlanConfigsArray of objects(VoiceVlanConfig_V1)unique

The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.

trustedPortsArray of objects(TrustedPort_V1)unique

The set of trusted port configurations for DHCP snooping and ARP inspection security features.

profileTypestring

The type of profile indicating its scope: global, venue specific, or template based.

Enum"Regular""CLI"
venueCliTemplateobject(AcxVenueCliTemplateView)

The CLI template configuration associated with this profile for custom command execution.

venuesArray of stringsunique

The set of venue identifiers where this profile is deployed or available for use.

venueCountinteger(int64)

The total number of venues where this profile is currently deployed.

templateIdstring

The identifier of the profile template used as the basis for this profile configuration.

templateVersioninteger(int64)

The version number of the profile template.

applyOnboardOnlyboolean

The flag indicating whether this profile should only be applied during switch onboarding.

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
}

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