Skip to content
/Configuration History

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

Get Configuration History

Request

Get the configuration history details for this transaction relative to the switches in this venue.

Security
jwtAuth
Path
venueIdstringrequired
transactionIdstringrequired
Body
required
filterByStatusstring

The status filter to limit results to configuration deployments with specific status values such as success, failed, or in progress.

Enum"ALL""SUCCESS""FAILED""NOTIFY_SUCCESS"
sortInfoobject(ConfigurationHistoryDetailSortInfo)

The sorting information specifying the sort column and direction for ordering configuration history records.

filterByConfigTypestring

The configuration type filter to limit results to specific types such as VLAN, ACL, or port configurations.

pageinteger(int32)

The page number for pagination, starting from 1, defaulting to 1.

limitinteger(int32)

The maximum number of configuration history records to return per page, defaulting to 8.

pageSizeinteger(int32)

The page size for pagination in the new request format, superseding the limit parameter when provided.

sortFieldstring

The sort column for ordering configuration history records in the new request format.

Enum"startTime""configType""dispatchStatus"
sortOrderstring

The sort order direction, either ascending or descending, for the new request format.

Enum"ASC""DESC"
filtersobject(ConfigurationHistoryFilter)

The comprehensive filter object containing multiple filter criteria in the new request format.

{
  "filterByStatus": "ALL",
  "sortInfo": {
    "sortColumn": "startTime",
    "dir": "ASC"
  },
  "filterByConfigType": "string",
  "page": 0,
  "limit": 0,
  "pageSize": 0,
  "sortField": "startTime",
  "sortOrder": "ASC",
  "filters": {
    "filterByStatus": "ALL",
    "configType": [ … ]
  }
}

Responses

OK

Body
idstring

The identifier

totalCountinteger(int32)

The total number of configuration history records matching the query criteria.

listArray of objects(ConfigurationHistoryInfo)

The list of configuration history information records containing deployment details and status.

Response
{
  "id": "string",
  "totalCount": 0,
  "list": [
    { … }
  ]
}

Get Configuration History

Request

Query for configuration history details on this switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
pageinteger(int32)

The page number for pagination, starting from 1.

pageSizeinteger(int32)

The number of records to return per page.

sortFieldstring

The field name used to sort the configuration history records.

Enum"startTime""configType""dispatchStatus"
sortOrderstring

The sort order direction for the query results, either ascending or descending.

Enum"ASC""DESC"
filterByConfigTypestring

The configuration type filter to limit results to specific types of configuration deployments.

Enum"PROVISIONING""ACL""VLAN""STATIC_ROUTE""PORT_CONFIGURATION""CLI_PROVISIONING""CLI_UPDATE""VE_PORTS""SPECIFIC_SETTING""LAG"
{
  "page": 0,
  "pageSize": 0,
  "sortField": "startTime",
  "sortOrder": "ASC",
  "filterByConfigType": "PROVISIONING"
}

Responses

OK

Body
idstring
totalCountinteger(int32)

The total number of configuration history records matching the query criteria.

listArray of objects(ConfigurationHistoryInfo_V1_1)

The list of configuration history information records containing deployment details and status.

Response
{
  "id": "string",
  "totalCount": 0,
  "list": [
    { … }
  ]
}

Get Configuration History

Request

Query for configuration history details for switches in this venue.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
sortInfoobject(SortInfo)

Sort information for ordering configuration history records (deprecated, use sortField and sortOrder instead).

filterByConfigTypestring

Filter configuration history by configuration type.

pageinteger(int32)

Page number for pagination.

limitinteger(int32)

Number of records per page (deprecated, use pageSize instead, default: 8).

pageSizeinteger(int32)

Number of records per page for the new request format.

sortFieldstring

Field to sort by (currently only supports startTime).

Value"startTime"
sortOrderstring

Sort order (ASC or DESC).

Enum"ASC""DESC"
filtersobject(ConfigurationHistoryFilter)

Filter criteria for configuration history records.

{
  "sortInfo": {
    "sortColumn": "startTime",
    "dir": "ASC"
  },
  "filterByConfigType": "string",
  "page": 0,
  "limit": 0,
  "pageSize": 0,
  "sortField": "startTime",
  "sortOrder": "ASC",
  "filters": {
    "filterByStatus": "ALL",
    "configType": [ … ]
  }
}

Responses

OK

Body
idstring

The identifier

totalCountinteger(int32)

The total number of configuration history venue records matching the query criteria.

listArray of objects(ConfigurationHistoryVenueInfo)

The list of venue level configuration history information records containing aggregated deployment statistics across multiple switches.

Response
{
  "id": "string",
  "totalCount": 0,
  "list": [
    { … }
  ]
}

Get Configuration History

Request

Get the configuration history details of this transaction on this switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
transactionIdstringrequired
No request payload

Responses

OK

Body
idstring
totalCountinteger(int32)

The total number of configuration history records matching the query criteria.

listArray of objects(ConfigurationHistoryInfo_V1_1)

The list of configuration history information records containing deployment details and status.

Response
{
  "id": "string",
  "totalCount": 0,
  "list": [
    { … }
  ]
}

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