Skip to content
Switch Services/
/
Get Template Switch Info

Switch Services (0.4.0)

Overview

The Switch Service REST API facilitates the management and configuration of RUCKUS ICX switches via the RUCKUS One platform. This API allows for programmatic control of switch operations, network configurations, security policies, and monitoring across various environments.

What This API Does

  • Manage ICX switch devices and their configurations
  • Configure network settings including VLANs, ports, LAGs, and virtual ethernet interfaces
  • Control security policies with AAA servers, ACLs, and trusted port settings
  • Create and apply switch profiles and templates for consistent configurations
  • Handle firmware upgrades and configuration backups
  • Configure DHCP servers and static routing
  • Import and onboard new switches to the platform
  • Manage CLI templates and web authentication pages

Authentication

All API calls require valid authentication via JWT (JSON Web Token) in Authorization header.

Regional Endpoints

Select the appropriate API endpoint based on your region:

  • North America: https://api.ruckus.cloud
  • Europe: https://api.eu.ruckus.cloud
  • Asia: https://api.asia.ruckus.cloud

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors.
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 switch configuration history records.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX switch settings.

Operations

Import Switch

Import and register new switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles and profile configurations.

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 switch configuration backups and restore operations.

Operations

Switch Firmware Upgrade

Manage switch firmware upgrade and scheduling operations.

Operations

Switch Ports

Manage switch port configurations.

Operations

Switch Static Routes

Manage static route configurations.

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

Get Web Authentication Template

Request

Get a web authentication page template by id.

Security
jwtAuth
Path
templateIdstringrequired
No request payload

Responses

OK

Body
idstring

The unique identifier of the Web Authentication page template.

namestring

The name of the Web Authentication page template for identification.

webAuthUserIdLabelstring

The custom label text for the username field on the Web Authentication login page.

webAuthPasswordLabelstring

The custom label text for the password field on the Web Authentication login page.

webAuthCustomTitlestring

The custom title text displayed at the top of the Web Authentication login page.

webAuthCustomTopstring

The custom HTML or text content displayed at the top section of the Web Authentication login page.

webAuthCustomLoginButtonstring

The custom text for the login button on the Web Authentication page.

webAuthCustomBottomstring

The custom HTML or text content displayed at the bottom section of the Web Authentication login page.

tagstring

The tag or label used for categorizing and filtering the Web Authentication page template.

venueCountinteger(int64)

The number of venues where this Web Authentication page template is applied.

switchCountinteger(int64)

The number of switches where this Web Authentication page template is applied.

SwitchAndVenue_V1Array of objects(SwitchAndVenue_V1)

The list of switches and venues where this Web Authentication page template is deployed.

WebAuthPageTemplateList_V1Array of objects(WebAuthPageTemplate_V1)

The list of Web Authentication page template instances for batch operations or nested template management.

Response
{
  "id": "string",
  "name": "string",
  "webAuthUserIdLabel": "string",
  "webAuthPasswordLabel": "string",
  "webAuthCustomTitle": "string",
  "webAuthCustomTop": "string",
  "webAuthCustomLoginButton": "string",
  "webAuthCustomBottom": "string",
  "tag": "string",
  "venueCount": 0,
  "switchCount": 0,
  "SwitchAndVenue_V1": [
    { … }
  ],
  "WebAuthPageTemplateList_V1": [
    {}
  ]
}

Update Web Authentication Template

Request

Update web authentication page template by id.

Security
jwtAuth
Path
templateIdstringrequired
Body
required
idstring[ 0 .. 37 ] characters

Unique identifier for the web auth page template (maximum 37 characters).

namestring[ 0 .. 32 ] charactersrequired

Template name for identification (maximum 32 characters, required).

webAuthPasswordLabelstring[ 0 .. 32 ] characters

Custom label text for the password input field (maximum 32 characters).

webAuthCustomTitlestring[ 0 .. 128 ] characters

Custom title text displayed at the top of the login page (maximum 128 characters).

webAuthCustomTopstring[ 0 .. 255 ] characters

Custom text displayed at the top section of the login page (maximum 255 characters).

webAuthCustomLoginButtonstring[ 0 .. 32 ] characters

Custom text for the login button (maximum 32 characters).

webAuthCustomBottomstring[ 0 .. 255 ] characters

Custom text displayed at the bottom section of the login page (maximum 255 characters).

tagstring[ 0 .. 255 ] characters

Tag for categorizing or grouping templates (maximum 255 characters).

tenantIdstring

The unique identifier of the tenant.

{
  "id": "string",
  "name": "string",
  "webAuthPasswordLabel": "string",
  "webAuthCustomTitle": "string",
  "webAuthCustomTop": "string",
  "webAuthCustomLoginButton": "string",
  "webAuthCustomBottom": "string",
  "tag": "string",
  "tenantId": "string"
}

Responses

OK

Body
idstring

The unique identifier of the Web Authentication page template.

namestring

The name of the Web Authentication page template for identification.

webAuthUserIdLabelstring

The custom label text for the username field on the Web Authentication login page.

webAuthPasswordLabelstring

The custom label text for the password field on the Web Authentication login page.

webAuthCustomTitlestring

The custom title text displayed at the top of the Web Authentication login page.

webAuthCustomTopstring

The custom HTML or text content displayed at the top section of the Web Authentication login page.

webAuthCustomLoginButtonstring

The custom text for the login button on the Web Authentication page.

webAuthCustomBottomstring

The custom HTML or text content displayed at the bottom section of the Web Authentication login page.

tagstring

The tag or label used for categorizing and filtering the Web Authentication page template.

venueCountinteger(int64)

The number of venues where this Web Authentication page template is applied.

switchCountinteger(int64)

The number of switches where this Web Authentication page template is applied.

SwitchAndVenue_V1Array of objects(SwitchAndVenue_V1)

The list of switches and venues where this Web Authentication page template is deployed.

WebAuthPageTemplateList_V1Array of objects(WebAuthPageTemplate_V1)

The list of Web Authentication page template instances for batch operations or nested template management.

Response
{
  "id": "string",
  "name": "string",
  "webAuthUserIdLabel": "string",
  "webAuthPasswordLabel": "string",
  "webAuthCustomTitle": "string",
  "webAuthCustomTop": "string",
  "webAuthCustomLoginButton": "string",
  "webAuthCustomBottom": "string",
  "tag": "string",
  "venueCount": 0,
  "switchCount": 0,
  "SwitchAndVenue_V1": [
    { … }
  ],
  "WebAuthPageTemplateList_V1": [
    {}
  ]
}

Delete Web Authentication Template

Request

Delete web authentication page template by id.

Security
jwtAuth
Path
templateIdstringrequired
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 Web Authentication Template

Request

Add web authentication page template.

Security
jwtAuth
Body
required
idstring[ 0 .. 37 ] characters

Unique identifier for the web auth page template (maximum 37 characters).

namestring[ 0 .. 32 ] charactersrequired

Template name for identification (maximum 32 characters, required).

webAuthPasswordLabelstring[ 0 .. 32 ] characters

Custom label text for the password input field (maximum 32 characters).

webAuthCustomTitlestring[ 0 .. 128 ] characters

Custom title text displayed at the top of the login page (maximum 128 characters).

webAuthCustomTopstring[ 0 .. 255 ] characters

Custom text displayed at the top section of the login page (maximum 255 characters).

webAuthCustomLoginButtonstring[ 0 .. 32 ] characters

Custom text for the login button (maximum 32 characters).

webAuthCustomBottomstring[ 0 .. 255 ] characters

Custom text displayed at the bottom section of the login page (maximum 255 characters).

tagstring[ 0 .. 255 ] characters

Tag for categorizing or grouping templates (maximum 255 characters).

tenantIdstring

The unique identifier of the tenant.

{
  "id": "string",
  "name": "string",
  "webAuthPasswordLabel": "string",
  "webAuthCustomTitle": "string",
  "webAuthCustomTop": "string",
  "webAuthCustomLoginButton": "string",
  "webAuthCustomBottom": "string",
  "tag": "string",
  "tenantId": "string"
}

Responses

OK

Body
idstring

The unique identifier of the Web Authentication page template.

namestring

The name of the Web Authentication page template for identification.

webAuthUserIdLabelstring

The custom label text for the username field on the Web Authentication login page.

webAuthPasswordLabelstring

The custom label text for the password field on the Web Authentication login page.

webAuthCustomTitlestring

The custom title text displayed at the top of the Web Authentication login page.

webAuthCustomTopstring

The custom HTML or text content displayed at the top section of the Web Authentication login page.

webAuthCustomLoginButtonstring

The custom text for the login button on the Web Authentication page.

webAuthCustomBottomstring

The custom HTML or text content displayed at the bottom section of the Web Authentication login page.

tagstring

The tag or label used for categorizing and filtering the Web Authentication page template.

venueCountinteger(int64)

The number of venues where this Web Authentication page template is applied.

switchCountinteger(int64)

The number of switches where this Web Authentication page template is applied.

SwitchAndVenue_V1Array of objects(SwitchAndVenue_V1)

The list of switches and venues where this Web Authentication page template is deployed.

WebAuthPageTemplateList_V1Array of objects(WebAuthPageTemplate_V1)

The list of Web Authentication page template instances for batch operations or nested template management.

Response
{
  "id": "string",
  "name": "string",
  "webAuthUserIdLabel": "string",
  "webAuthPasswordLabel": "string",
  "webAuthCustomTitle": "string",
  "webAuthCustomTop": "string",
  "webAuthCustomLoginButton": "string",
  "webAuthCustomBottom": "string",
  "tag": "string",
  "venueCount": 0,
  "switchCount": 0,
  "SwitchAndVenue_V1": [
    { … }
  ],
  "WebAuthPageTemplateList_V1": [
    {}
  ]
}

Query Web Authentication Templates

Request

List of tenant's web authentication page templates.

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"
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC"
}

Responses

OK

Body
idstring
dataArray of any

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 Template Switch Info

Request

Get a web authentication page template's switch info by id.

Security
jwtAuth
Path
templateIdstringrequired
No request payload

Responses

OK

Body
idstring

The unique identifier of the Web Authentication page template.

namestring

The name of the Web Authentication page template for identification.

webAuthUserIdLabelstring

The custom label text for the username field on the Web Authentication login page.

webAuthPasswordLabelstring

The custom label text for the password field on the Web Authentication login page.

webAuthCustomTitlestring

The custom title text displayed at the top of the Web Authentication login page.

webAuthCustomTopstring

The custom HTML or text content displayed at the top section of the Web Authentication login page.

webAuthCustomLoginButtonstring

The custom text for the login button on the Web Authentication page.

webAuthCustomBottomstring

The custom HTML or text content displayed at the bottom section of the Web Authentication login page.

tagstring

The tag or label used for categorizing and filtering the Web Authentication page template.

venueCountinteger(int64)

The number of venues where this Web Authentication page template is applied.

switchCountinteger(int64)

The number of switches where this Web Authentication page template is applied.

SwitchAndVenue_V1Array of objects(SwitchAndVenue_V1)

The list of switches and venues where this Web Authentication page template is deployed.

WebAuthPageTemplateList_V1Array of objects(WebAuthPageTemplate_V1)

The list of Web Authentication page template instances for batch operations or nested template management.

Response
{
  "id": "string",
  "name": "string",
  "webAuthUserIdLabel": "string",
  "webAuthPasswordLabel": "string",
  "webAuthCustomTitle": "string",
  "webAuthCustomTop": "string",
  "webAuthCustomLoginButton": "string",
  "webAuthCustomBottom": "string",
  "tag": "string",
  "venueCount": 0,
  "switchCount": 0,
  "SwitchAndVenue_V1": [
    { … }
  ],
  "WebAuthPageTemplateList_V1": [
    {}
  ]
}