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

Get Switch Configuration Backups

Request

List of switch's configuration backup.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

No request payload

Responses

Body

Array [

idstring

createdDatestring(date-time)

The timestamp when this configuration backup was created.

namestring

The name identifier for this configuration backup.

backupIdstring

The unique identifier for this configuration backup.

switchIdstring

The identifier of the switch that this configuration backup belongs to.

backupTypestring

The type of configuration backup, such as automatic, manual, or scheduled.

configstring

The complete configuration content stored in this backup.

statusstring

The current status of this backup operation, such as completed, in progress, or failed.

restoreStatusstring

The status of the most recent restore operation using this backup.

restoreTimestampstring

The timestamp when this configuration was last restored to a switch.

failureReasonstring

The reason for backup or restore failure, providing diagnostic information when operations fail.

]

Response

[
  {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "backupId": "string",
    "switchId": "string",
    "backupType": "string",
    "config": "string",
    "status": "string",
    "restoreStatus": "string",
    "restoreTimestamp": "string",
    "failureReason": "string"
  }
]

Add Switch Configuration Backup

Request

Create a switch's configuration backup.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

Body

required

namestring^(?:(?!").){1,64}$

The name for this configuration backup, with a length between 1 and 64 characters and excluding double quotes.

{
  "name": "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"
  }
}

Delete Switch Configuration Backups

Request

Delete switch's configuration backups.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

Body

requiredArray [

string

]

[
  "string"
]

Responses

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

Retrieve Switch Configuration Backups

Request

Query the switch's configuration backups.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

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

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
}

Compare Switch Configuration Backups

Request

Compare switch's configuration backups.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

Body

required

backupId1string

First configuration backup id for comparison.

backupId2string

Second configuration backup id for comparison.

{
  "backupId1": "string",
  "backupId2": "string"
}

Responses

Body

idstring

configBackup1object(ConfigBackupContent_V1_1)

The first configuration backup content for comparison.

configBackup2object(ConfigBackupContent_V1_1)

The second configuration backup content to compare against the first backup.

Response

{
  "id": "string",
  "configBackup1": {
    "id": "string",
    "config": "string"
  },
  "configBackup2": {
    "id": "string",
    "config": "string"
  }
}

Get Switch Configuration Backup

Request

Get a switch's configuration backup.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

configBackupIdstringrequired

No request payload

Responses

Body

idstring

createdDatestring(date-time)

The timestamp when this configuration backup was created.

namestring

The name identifier for this configuration backup.

backupIdstring

The unique identifier for this configuration backup.

switchIdstring

The identifier of the switch that this configuration backup belongs to.

backupTypestring

The type of configuration backup, such as automatic, manual, or scheduled.

configstring

The complete configuration content stored in this backup.

statusstring

The current status of this backup operation, such as completed, in progress, or failed.

restoreStatusstring

The status of the most recent restore operation using this backup.

restoreTimestampstring

The timestamp when this configuration was last restored to a switch.

failureReasonstring

The reason for backup or restore failure, providing diagnostic information when operations fail.

Response

{
  "id": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "backupId": "string",
  "switchId": "string",
  "backupType": "string",
  "config": "string",
  "status": "string",
  "restoreStatus": "string",
  "restoreTimestamp": "string",
  "failureReason": "string"
}

Delete Switch Configuration Backup

Request

Delete switch's configuration backup by id.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

configBackupIdstringrequired

No request payload

Responses

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

Restore Switch Configuration Backup

Request

Restore switch's configuration backup.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

configBackupIdstringrequired

Body

required

configBackupActionstring

The action to perform on the configuration backup, either restore to a switch or download for external storage.

Enum"restore""download"

{
  "configBackupAction": "restore"
}

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

Retrieve Formatted Configuration Backup

Request

Retrieve formatted string representation of switch's configuration backup for convert to template.

Security

jwtAuth

Path

venueIdstringrequired

switchIdstringrequired

configBackupIdstringrequired

No request payload

Responses

Body

idstring

switchIdstring

The identifier of the switch.

modelstring

The model of the switch.

venueIdstring

The identifier of venue.

clistring

The formatted CLI configuration content for template conversion.

namestring

The name of the configuration backup.

Response

{
  "id": "string",
  "switchId": "string",
  "model": "string",
  "venueId": "string",
  "cli": "string",
  "name": "string"
}

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