Switch Service API & Model Documentation (0.3.4)

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

Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.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

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

Get Web Authentication Template

Request

Get a web authentication page template by id.

Security

jwtAuth

Path

templateIdstringrequired

No request payload

Responses

Body

idstring

namestring

webAuthUserIdLabelstring

webAuthPasswordLabelstring

webAuthCustomTitlestring

webAuthCustomTopstring

webAuthCustomLoginButtonstring

webAuthCustomBottomstring

tagstring

venueCountinteger(int64)

switchCountinteger(int64)

switchVenueInfosArray of objects(SwitchAndVenueView)

webAuthPageTemplateViewListArray of objects(WebAuthPageTemplateView)

Response

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

Update Web Authentication Template

Request

Update web authentication page template by id.

Security

jwtAuth

Path

templateIdstringrequired

Body

required

idstring[ 0 .. 37 ] characters

namestring[ 0 .. 32 ] charactersrequired

webAuthPasswordLabelstring[ 0 .. 32 ] characters

webAuthCustomTitlestring[ 0 .. 128 ] characters

webAuthCustomTopstring[ 0 .. 255 ] characters

webAuthCustomLoginButtonstring[ 0 .. 32 ] characters

webAuthCustomBottomstring[ 0 .. 255 ] characters

tagstring[ 0 .. 255 ] characters

tenantIdstring

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

Responses

Body

idstring

namestring

webAuthUserIdLabelstring

webAuthPasswordLabelstring

webAuthCustomTitlestring

webAuthCustomTopstring

webAuthCustomLoginButtonstring

webAuthCustomBottomstring

tagstring

venueCountinteger(int64)

switchCountinteger(int64)

switchVenueInfosArray of objects(SwitchAndVenueView)

webAuthPageTemplateViewListArray of objects(WebAuthPageTemplateView)

Response

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

Delete Web Authentication Template

Request

Delete web authentication page template by id.

Security

jwtAuth

Path

templateIdstringrequired

No request payload

Responses

Body

requestIdstring

responseobject(EmptyView)

Response

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

Add Web Authentication Template

Request

Add web authentication page template.

Security

jwtAuth

Body

required

idstring[ 0 .. 37 ] characters

namestring[ 0 .. 32 ] charactersrequired

webAuthPasswordLabelstring[ 0 .. 32 ] characters

webAuthCustomTitlestring[ 0 .. 128 ] characters

webAuthCustomTopstring[ 0 .. 255 ] characters

webAuthCustomLoginButtonstring[ 0 .. 32 ] characters

webAuthCustomBottomstring[ 0 .. 255 ] characters

tagstring[ 0 .. 255 ] characters

tenantIdstring

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

Responses

Body

idstring

namestring

webAuthUserIdLabelstring

webAuthPasswordLabelstring

webAuthCustomTitlestring

webAuthCustomTopstring

webAuthCustomLoginButtonstring

webAuthCustomBottomstring

tagstring

venueCountinteger(int64)

switchCountinteger(int64)

switchVenueInfosArray of objects(SwitchAndVenueView)

webAuthPageTemplateViewListArray of objects(WebAuthPageTemplateView)

Response

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

Query Web Authentication Templates

Request

List of tenant's web authentication page templates.

Security

jwtAuth

Body

required

fieldsArray of strings

pageinteger(int32)

pageSizeinteger(int32)

sortFieldstring

sortOrderstring

Enum"ASC""DESC"

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC"
}

Responses

Body

idstring

dataArray of objects

fieldsArray of strings

pageinteger(int32)

totalCountinteger(int64)

totalPagesinteger(int32)

Response

{
  "id": "string",
  "data": [
    {}
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Get Web Authentication Template's Switch Info

Request

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

Security

jwtAuth

Path

templateIdstringrequired

No request payload

Responses

Body

idstring

namestring

webAuthUserIdLabelstring

webAuthPasswordLabelstring

webAuthCustomTitlestring

webAuthCustomTopstring

webAuthCustomLoginButtonstring

webAuthCustomBottomstring

tagstring

venueCountinteger(int64)

switchCountinteger(int64)

switchVenueInfosArray of objects(SwitchAndVenueView)

webAuthPageTemplateViewListArray of objects(WebAuthPageTemplateView)

Response

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