RUCKUS Cloud - Switch API and Model Documentation (v21.04.12)

APIs published in this document are subject to strict change control by RUCKUS. As far as possible, when new versions of the Public API are published, all documented API endpoints will maintain backward compatibility. When not possible, an API endpoint will be deprecated and a replacement API or some other workaround will be provided. Support for deprecated API endpoints will continue for at least six months prior to removal in order to provide API client developers sufficient time to adopt the replacement. This document will indicate when API endpoints are deprecated along with the schedule for their removal. API client developers may discover other experimental API endpoints provided by the RUCKUS cloud, not included in this API document. RUCKUS reserves the right to change these experimental APIs without notice to API client developers.

RUCKUS Cloud API Documents

This document, Switch APIs and Model Documentation, is one of four documents describing the RUCKUS Cloud public API. Different API endpoints are described in each of the four documents, which are arranged according to the resources managed. Corresponding to each of the 4 HTML documents is an Open API v3 JSON document, which can be used to generate code for API clients.

Document NameResources Managed
switch-ns-210412.htmlICX switch related resources. This document describes API endpoints related to managing your switches and wired networks.
msp-ns-210412.htmlMSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks.
platform-ns-210412.htmlPlatform related resources. This document describes API endpoints related to your account including administrators and their notification preferences, venues and your entitlements/licenses.
wifi-ns-210412.htmlWi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks.

Documentation Change Notes for Release 21.04.12

The following documentation changes were made in this release:
  • The companion JSON document, “switch-ns-210412.json” has been upgraded to Open API version 3; the document for earlier releases used version 2.

Cloud Hosts

RegionDomain
Asiahttps://asia.ruckus.cloud
Europehttps://eu.ruckus.cloud
North Americahttps://ruckus.cloud

Additional Information

RUCKUS Cloud release 21.04.12 manages ICX switches deployed with Fastiron firmware version 8.0.95. In this API document, you may read about topics unfamiliar to you; for example, ACLs, LAGs, trusted ports, etc. A thorough treatment of these topics is beyond the scope of this document. However, these topics and more are covered in detail in the Fastiron configuration guides. Links to configuration guides for Fastiron firmware are provided in the table below.
FormatURL
HTMLThe complete set of FastIron product guides supporting firmware version 08.0.95 is available on the CommScope Technical Content Portal here: https://docs.commscope.com/bundle?labelkey=fi-08.0.95.
PDF bundleA zip bundle of all FastIron product guides supporting firmware version 08.0.95 is available on the RUCKUS Support Portal here (~50MB): https://support.ruckuswireless.com/documents/3446-fastiron-08-0-95-ga-software-documentation-zip.
PDFIndividual PDF configuration guides can be downloaded on the RUCKUS Support Portal by navigating to the RUCKUS ICX product area, https://support.ruckuswireless.com/product_families/21-ruckus-icx-switches, selecting an ICX Model you’ve deployed, then selecting the “Documents” tab midway down the page.

Authentication

Token

API clients use an API-KEY to access REST endpoints. In order to obtain an API-KEY, an administrator uses the endpoints in the "API Client Authentication" group, available on all cloud hosts. The API-KEY issued will have the same access privileges (aka role) as the administrator who obtained the key. Please see document platform-ns-210412.html for details.

Security Scheme Type API Key
Header parameter name: Cookie

New Endpoints in Release

New Group of API Endpoints - "Configuration History"


Retrieve configuration history.
New MethodsNew Paths
POST "/api/switch/tenant/{tenantId}/switches/{id}/configurationHistory/detail/query"
POST "/api/switch/tenant/{tenantId}/switches/{id}/configurationHistory/detail/{transactionId}"
POST "/api/switch/tenant/{tenantId}/venues/{id}/configurationHistory/detail/{transactionId}"
POST "/api/switch/tenant/{tenantId}/venues/{id}/configurationHistory/query"

ICX Switch

Manage ICX Switches.

Get ICX Switches

List of tenant's ICX switches.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update ICX Switch

Update ICX switch.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

defaultGateway
string
description
string [ 0 .. 255 ] characters
enableStack
boolean

The default value is false.

firmwareVersion
string
id
required
string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK...
igmpSnooping
string
Enum: "active" "passive" "none"
ipAddress
string
ipAddressInterface
string
ipAddressInterfaceType
string
Enum: "PORT" "VE"
ipAddressType
string
Enum: "static" "dynamic"
isPrimaryDeleted
boolean

The default value is false.

jumboMode
boolean

The default value is false.

lastDataSyncTime
integer <int64>
lastDataSyncTriggerTime
integer <int64>
name
string^$|^(?:(?!").){1,255}$
object (SwitchPosition)

Switch Position object

previousMembers
Array of strings
sendedHostname
boolean

The default value is false.

softDeleted
boolean

The default value is false.

softDeletedDate
string <date-time>
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
Array of objects (StackMembers)
subnetMask
string
syncDataEndTime
integer <int64>
syncDataId
string
syncDataStartTime
integer <int64>
tags
string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$...
venueId
required
string

Responses

Request samples

Content type
application/json
{
  • "defaultGateway": "string",
  • "description": "string",
  • "enableStack": true,
  • "firmwareVersion": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "PORT",
  • "ipAddressType": "static",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "lastDataSyncTime": 0,
  • "lastDataSyncTriggerTime": 0,
  • "name": "string",
  • "position": {
    },
  • "previousMembers": [
    ],
  • "sendedHostname": true,
  • "softDeleted": true,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "syncDataEndTime": 0,
  • "syncDataId": "string",
  • "syncDataStartTime": 0,
  • "tags": "string",
  • "venueId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Add ICX Switch

Add ICX switch.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

defaultGateway
string
description
string [ 0 .. 255 ] characters
enableStack
boolean

The default value is false.

firmwareVersion
string
id
required
string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK...
igmpSnooping
string
Enum: "active" "passive" "none"
ipAddress
string
ipAddressInterface
string
ipAddressInterfaceType
string
Enum: "PORT" "VE"
ipAddressType
string
Enum: "static" "dynamic"
isPrimaryDeleted
boolean

The default value is false.

jumboMode
boolean

The default value is false.

lastDataSyncTime
integer <int64>
lastDataSyncTriggerTime
integer <int64>
name
string^$|^(?:(?!").){1,255}$
object (SwitchPosition)

Switch Position object

previousMembers
Array of strings
sendedHostname
boolean

The default value is false.

softDeleted
boolean

The default value is false.

softDeletedDate
string <date-time>
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
Array of objects (StackMembers)
subnetMask
string
syncDataEndTime
integer <int64>
syncDataId
string
syncDataStartTime
integer <int64>
tags
string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$...
venueId
required
string

Responses

Request samples

Content type
application/json
{
  • "defaultGateway": "string",
  • "description": "string",
  • "enableStack": true,
  • "firmwareVersion": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "PORT",
  • "ipAddressType": "static",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "lastDataSyncTime": 0,
  • "lastDataSyncTriggerTime": 0,
  • "name": "string",
  • "position": {
    },
  • "previousMembers": [
    ],
  • "sendedHostname": true,
  • "softDeleted": true,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "syncDataEndTime": 0,
  • "syncDataId": "string",
  • "syncDataStartTime": 0,
  • "tags": "string",
  • "venueId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get ICX Switches

List of venues' ICX switches.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get ICX Switch

Get ICX switch.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "defaultGateway": "string",
  • "description": "string",
  • "enableStack": true,
  • "firmwareVersion": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "PORT",
  • "ipAddressType": "static",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "lastDataSyncTime": 0,
  • "lastDataSyncTriggerTime": 0,
  • "name": "string",
  • "position": {
    },
  • "previousMembers": [
    ],
  • "sendedHostname": true,
  • "softDeleted": true,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "syncDataEndTime": 0,
  • "syncDataId": "string",
  • "syncDataStartTime": 0,
  • "tags": "string",
  • "venueId": "string"
}

Delete ICX Switch

Delete ICX switch.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Add Member

Add member.

Authorizations:
path Parameters
memberId
required
string

memberId

serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Ping

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

targetHost
required
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...

Responses

Request samples

Content type
application/json
{
  • "targetHost": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Update ICX Switch

Update ICX switch position.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

floorplanId
string
xPercent
number <float> [ 0 .. 100 ]
yPercent
number <float> [ 0 .. 100 ]

Responses

Request samples

Content type
application/json
{
  • "floorplanId": "string",
  • "xPercent": 0,
  • "yPercent": 0
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Reboot Switch

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Route Table

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Trace Route

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

maxTtl
integer <int32> [ 0 .. 255 ]

default: 30

targetHost
required
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...

Responses

Request samples

Content type
application/json
{
  • "maxTtl": 0,
  • "targetHost": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Update ICX Switch

Update ICX switch firmware.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

firmwareVersion
string
scheduledTime
string

Responses

Request samples

Content type
application/json
{
  • "firmwareVersion": "string",
  • "scheduledTime": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Add ICX Switches

Add ICX switches.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
defaultGateway
string
description
string [ 0 .. 255 ] characters
enableStack
boolean

The default value is false.

firmwareVersion
string
id
required
string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK...
igmpSnooping
string
Enum: "active" "passive" "none"
ipAddress
string
ipAddressInterface
string
ipAddressInterfaceType
string
Enum: "PORT" "VE"
ipAddressType
string
Enum: "static" "dynamic"
isPrimaryDeleted
boolean

The default value is false.

jumboMode
boolean

The default value is false.

lastDataSyncTime
integer <int64>
lastDataSyncTriggerTime
integer <int64>
name
string^$|^(?:(?!").){1,255}$
object (SwitchPosition)

Switch Position object

previousMembers
Array of strings
sendedHostname
boolean

The default value is false.

softDeleted
boolean

The default value is false.

softDeletedDate
string <date-time>
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
Array of objects (StackMembers)
subnetMask
string
syncDataEndTime
integer <int64>
syncDataId
string
syncDataStartTime
integer <int64>
tags
string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$...
venueId
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Delete ICX Switches

Delete ICX switches.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: */*

viewInput

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Stack Members

Manage stack members.

Get Stack Members

List of stack members.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Stack Member

Add stack member.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

id
required
string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK...

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Stack Member

Delete stack member.

Authorizations:
path Parameters
stackSwitchSerialNumber
required
string

stackSwitchSerialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Profile

Manage switch profiles.

Update Profile

Update tenant's profile.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array of objects (Acl)

ACL profile.

description
string
id
string
name
required
string(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
Array of objects (TrustedPort)

Manage port's trust settings.

venues
Array of strings
Array of objects (Vlan)

VLAN profile.

Responses

Request samples

Content type
application/json
{
  • "acls": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "trustedPorts": [
    ],
  • "venues": [
    ],
  • "vlans": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Add Profile

Add tenant's profile.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array of objects (Acl)

ACL profile.

description
string
id
string
name
required
string(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
Array of objects (TrustedPort)

Manage port's trust settings.

venues
Array of strings
Array of objects (Vlan)

VLAN profile.

Responses

Request samples

Content type
application/json
{
  • "acls": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "trustedPorts": [
    ],
  • "venues": [
    ],
  • "vlans": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Profile

Get tenant's profile.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "acls": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "trustedPorts": [
    ],
  • "venues": [
    ],
  • "vlans": [
    ]
}

Delete Profile

Delete tenant's profile.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Profiles

List of tenant's profiles.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Profiles

Delete tenant's profiles.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: */*

viewInput

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Profiles

List of venue's profiles.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Venue

Manage a switch's venue-level settings.

Update Venue

Update switch's venue-level settings.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

dns
Array of strings
firmware
string
id
string
name
string
profileId
string
switchLoginPassword
string
switchLoginUsername
string
syslogEnabled
boolean

The default value is false.

syslogPrimaryServer
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...
syslogSecondaryServer
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...

Responses

Request samples

Content type
application/json
{
  • "dns": [
    ],
  • "firmware": "string",
  • "id": "string",
  • "name": "string",
  • "profileId": "string",
  • "switchLoginPassword": "string",
  • "switchLoginUsername": "string",
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Venue

Get switch's venue-level settings.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
{
  • "dns": [
    ],
  • "firmware": "string",
  • "id": "string",
  • "name": "string",
  • "profileId": "string",
  • "switchLoginPassword": "string",
  • "switchLoginUsername": "string",
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Port

Manage Ports.

Get Ports

List of switch's port settings.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Ports

Get different switches' port settings.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

deviceId
string
dhcpSnoopingTrust
boolean

The default value is false.

egressAcl
string
id
string
ignoreFields
string
ingressAcl
string
ipsg
boolean

The default value is false.

object (Lag)

domain object representing LAG Model

lldpEnable
boolean

The default value is true.

Array of objects (LldpQos)
name
string
poeBudget
number <float> [ 1000 .. 30000 ]
poeCapability
boolean

The default value is true.

poeClass
string
Enum: "UNSET" "ZERO" "ONE" "TWO" "THREE" "FOUR"
poeEnable
boolean

The default value is true.

poePriority
integer <int32>
port
string^\d{1,2}/\d{1,2}/\d{1,2}$
portEnable
boolean

The default value is true.

portProtected
boolean

The default value is false.

portSpeed
string
Enum: "UNSET" "NONE" "AUTO" "TEN_M_FULL" "TEN_M_HALF" "ONE_HUNDRED_M_FULL" "ONE_HUNDRED_M_HALF" "ONE_G_FULL" "ONE_G_FULL_MASTER" "ONE_G_FULL_SLAVE" "TWO_POINT_FIVE_G_FULL" "TWO_POINT_FIVE_G_FULL_MASTER" "TWO_POINT_FIVE_G_FULL_SLAVE" "FIVE_G_FULL" "FIVE_G_FULL_MASTER" "FIVE_G_FULL_SLAVE" "TEN_G_FULL" "TEN_G_FULL_MASTER" "TEN_G_FULL_SLAVE" "TWENTY_FIVE_G_FULL" "FORTY_G_FULL" "ONE_HUNDRED_G_FULL" "OPTIC"
ports
Array of strings
revert
boolean

The default value is false.

rstpAdminEdgePort
boolean

The default value is false.

stpBpduGuard
boolean

The default value is false.

stpRootGuard
boolean

The default value is false.

switchSerialNumber
string
taggedVlans
Array of strings
tags
string
untaggedVlan
string
voiceVlan
integer <int32> [ 1 .. 4095 ]

Responses

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag": {
    },
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 1000,
  • "poeCapability": true,
  • "poeClass": "UNSET",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "UNSET",
  • "ports": [
    ],
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "switchSerialNumber": "string",
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 1
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Port

Get a switch's specific port setting.

Authorizations:
path Parameters
portNum
required
integer <int32>

portNum

serialNumber
required
string

serialNumber

slotNum
required
integer <int32>

slotNum

tenantId
required
string

Tenant ID

unitNum
required
integer <int32>

unitNum

Responses

Response samples

Content type
application/json
{
  • "deviceId": "string",
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag": {
    },
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 1000,
  • "poeCapability": true,
  • "poeClass": "UNSET",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "UNSET",
  • "ports": [
    ],
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "switchSerialNumber": "string",
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 1
}

Get Ports

Get switch's port setting.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Update Port

Update switch's port setting.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
object (Port)

domain object representing Port Model

switchSerialNumber
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Ports

Get different switches' port settings.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
ports
Array of strings
switchSerialNumber
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Trusted-Port

Manage portq trust settings.

Get Trusted-Ports

List of venues switch-profile port's trust settings.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Trusted-Port

Update switch-profile port's trust setting.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

id
string
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F"
Array of objects (FamilyModelSlot)

ICX model's slot setting.

trustPorts
Array of strings
trustedPortType
string
Enum: "all" "dhcp" "arp"

Trusted-port type setting.

vlanDemand
boolean

The default value is false.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "slots": [
    ],
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Add Trusted-Port

Add switch-profile port's trust setting.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

id
string
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F"
Array of objects (FamilyModelSlot)

ICX model's slot setting.

trustPorts
Array of strings
trustedPortType
string
Enum: "all" "dhcp" "arp"

Trusted-port type setting.

vlanDemand
boolean

The default value is false.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "slots": [
    ],
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Trusted-Port

Get switch-profile port's trust setting.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

trustedPortId
required
string

trustedPortId

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "slots": [
    ],
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Delete Trusted-Port

Delete switch-profile port's trust setting.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

trustedPortId
required
string

trustedPortId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

LAG

Manage LAGs (link aggregation groups).

Update LAG

Update switch's LAG setting.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

id
string
name
string^(?:(?!").){1,64}$
ports
Array of strings
taggedVlans
Array of strings
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ports": [
    ],
  • "taggedVlans": [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete LAGs

Delete switch's LAG settings.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: */*

viewInput

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get LAGs

List of switch's LAG settings.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add LAG

Add switch's LAG setting.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

id
string
name
string^(?:(?!").){1,64}$
ports
Array of strings
taggedVlans
Array of strings
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ports": [
    ],
  • "taggedVlans": [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get LAG

Get switch's LAG setting.

Authorizations:
path Parameters
lagId
required
string

lagId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ports": [
    ],
  • "taggedVlans": [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Delete LAG

Delete switch's LAG setting.

Authorizations:
path Parameters
lagId
required
string

lagId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Add LAGs

Add switch's LAG settings.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
id
string
name
string^(?:(?!").){1,64}$
ports
Array of strings
taggedVlans
Array of strings
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

VLAN

Manage VLANs.

Get VLANs

List of venues switch-profile VLANs.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get VLANs

List of venues switch-profile VLANs with specific model.

Authorizations:
path Parameters
model
required
string

model

tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Tagged VLANs

List of venues switch-profile VLANs with specific model and tagged port.

Authorizations:
path Parameters
model
required
string

model

slotId
required
integer <int32>

slotId

taggedPortId
required
integer <int32>

taggedPortId

tenantId
required
string

Tenant ID

unitId
required
integer <int32>

unitId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Untagged VLANs

List of venues switch-profile VLANs with specific model and untagged port.

Authorizations:
path Parameters
model
required
string

model

slotId
required
integer <int32>

slotId

tenantId
required
string

Tenant ID

unitId
required
integer <int32>

unitId

untaggedPortId
required
integer <int32>

untaggedPortId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update VLAN

Update switch-profile VLAN.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

arpInspection
boolean

The default value is false.

arpInspectionTrustPort
string
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
ipv4DhcpSnooping
boolean

The default value is false.

ipv4DhcpSnoopingTrustPort
string
multicastVersion
integer <int32> [ 2 .. 3 ]
rootBridgeFamilyId
string
Enum: "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (SwitchFamilyModel)

ICX switch model setting.

vlanId
integer <int32> [ 1 .. 4095 ]
vlanName
string [ 0 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 2,
  • "rootBridgeFamilyId": "ICX7150",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Add VLAN

Add switch-profile VLAN.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

arpInspection
boolean

The default value is false.

arpInspectionTrustPort
string
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
ipv4DhcpSnooping
boolean

The default value is false.

ipv4DhcpSnoopingTrustPort
string
multicastVersion
integer <int32> [ 2 .. 3 ]
rootBridgeFamilyId
string
Enum: "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (SwitchFamilyModel)

ICX switch model setting.

vlanId
integer <int32> [ 1 .. 4095 ]
vlanName
string [ 0 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 2,
  • "rootBridgeFamilyId": "ICX7150",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get VLAN

Get switch-profile VLAN.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

vlanUuid
required
string

vlanUuid

Responses

Response samples

Content type
application/json
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 2,
  • "rootBridgeFamilyId": "ICX7150",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Delete VLAN

Delete switch-profile VLAN.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

vlanUuid
required
string

vlanUuid

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get VLANs

List of switch-profile VLANs.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

query Parameters
page
string

page

size
string

size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete VLANs

Delete switch-profile VLANs.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: */*

viewInput

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Switch-VLAN

Manage switch-level VLANs.

Get Default VLAN

Get switches' default VLAN.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Get All VLANs Intersection

Get all VLAN intersection of switch.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get All VLANs Union

Get all VLANs union of switch.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "profileVlan": [
    ],
  • "switchDefaultVlan": [
    ],
  • "switchVlan": [
    ]
}

VE Port

Manage VE (virtual Ethernet) port settings.

Update VE Setting

Update switch's VE setting.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

defaultVlan
boolean

default: false

dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipAddressType
string
Enum: "static" "dynamic"
ipSubnetMask
string
name
string
ospfArea
string
veId
integer <int32> [ 1 .. 4095 ]
vlanId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "defaultVlan": true,
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "veId": 1,
  • "vlanId": 0
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get VE Settings

List of switch's VE settings.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add VE Setting

Add switch's VE setting.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

defaultVlan
boolean

default: false

dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipAddressType
string
Enum: "static" "dynamic"
ipSubnetMask
string
name
string
ospfArea
string
veId
integer <int32> [ 1 .. 4095 ]
vlanId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "defaultVlan": true,
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "veId": 1,
  • "vlanId": 0
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get VE Setting

Get switch's VE setting.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

vePortId
required
string

vePortId

Responses

Response samples

Content type
application/json
{
  • "defaultVlan": true,
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "veId": 1,
  • "vlanId": 0
}

Delete VE Setting

Delete switch's VE setting.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

vePortId
required
string

vePortId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete VE Settings

Delete switch's VE settings.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: */*

viewInput

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Add VE Settings

Add switch's VE settings.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
defaultVlan
boolean

default: false

dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipAddressType
string
Enum: "static" "dynamic"
ipSubnetMask
string
name
string
ospfArea
string
veId
integer <int32> [ 1 .. 4095 ]
vlanId
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

Static-Route

Manage static routes.

Update Static-Route

Update switch's static-Route setting.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2...
id
string
nextHop
string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2...

Responses

Request samples

Content type
application/json
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Static-Routes

List of switch's static-Route settings.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Static-Route

Add switch's static-Route setting.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2...
id
string
nextHop
string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2...

Responses

Request samples

Content type
application/json
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Static-Route

Get switch's static-Route setting.

Authorizations:
path Parameters
staticRouteId
required
string

staticRouteId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string"
}

Delete Static-Route

Delete switch's static-Route setting.

Authorizations:
path Parameters
staticRouteId
required
string

staticRouteId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete Static-Routes

Delete switch's static-Route settings.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: */*

viewInput

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Add Static-Routes

Add switch's static-Route settings.

Authorizations:
path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2...
id
string
nextHop
string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2...

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": [
    ]
}

ACL

Manage switch-profile ACLs (access control lists).

Get ACLs

List of venues switch-profile ACLs.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update ACL

Update switch-profile ACL.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array of objects (AclRule)

Setting the ACL rules.

aclType
string
Enum: "standard" "extended"
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Add ACL

Add switch-profile ACL.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array of objects (AclRule)

Setting the ACL rules.

aclType
string
Enum: "standard" "extended"
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get ACL

Get switch-profile ACL.

Authorizations:
path Parameters
aclId
required
string

aclId

profileId
required
string

profileId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "id": "string",
  • "name": "string"
}

Delete ACL

Delete switch-profile ACL.

Authorizations:
path Parameters
aclId
required
string

aclId

profileId
required
string

profileId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get ACLs

List of switch-profile ACL.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

query Parameters
page
string

page

size
string

size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete ACLs

Delete switch-profile ACLs.

Authorizations:
path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: */*

viewInput

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Configuration History

Retrieve configuration history.

Get Configuration History

Query for configuration history details on this switch.

Authorizations:
path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

filterByConfigType
string
filterByStatus
string
Enum: "ALL" "SUCCESS" "FAILED"

Filter By DispatchStatus In Configuration History

limit
integer <int32>

default: 8

page
integer <int32>

default: 1

object (ConfigurationHistoryDetailSortInfo)

Configuration History Detail Sort Infomation

Responses

Request samples

Content type
application/json
{
  • "filterByConfigType": "string",
  • "filterByStatus": "ALL",
  • "limit": 0,
  • "page": 0,
  • "sortInfo": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Configuration History by Transaction

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

Authorizations:
path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

transactionId
required
string

transactionId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Configuration History by Venue & Transaction

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

Authorizations:
path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

transactionId
required
string

transactionId

Request Body schema: application/json

viewInput

filterByConfigType
string
filterByStatus
string
Enum: "ALL" "SUCCESS" "FAILED"

Filter By DispatchStatus In Configuration History

limit
integer <int32>

default: 8

page
integer <int32>

default: 1

object (ConfigurationHistoryDetailSortInfo)

Configuration History Detail Sort Infomation

Responses

Request samples

Content type
application/json
{
  • "filterByConfigType": "string",
  • "filterByStatus": "ALL",
  • "limit": 0,
  • "page": 0,
  • "sortInfo": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Configuration History by Venue

Query for configuration history details for switches in this venue.

Authorizations:
path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

object (FullTextSearchFilter)

Full Text Search Filter

limit
integer <int32>

default: 8

page
integer <int32>

default: 1

object (ConfigurationHistorySortInfo)

Configuration History Sort Infomation

Responses

Request samples

Content type
application/json
{
  • "fullTextSearch": {
    },
  • "limit": 0,
  • "page": 0,
  • "sortInfo": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Configuration Backup

Manage configuration backups.

Delete Configuration Backups

Delete switch's configuration backups.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: */*

viewInput

Array ()
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Compare Configuration Backups

Compare switch's configuration backups.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

backupId1
required
string
backupId2
required
string

Responses

Request samples

Content type
application/json
{
  • "backupId1": "string",
  • "backupId2": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Configuration Backup

Get a switch's configuration backup full content.

Authorizations:
path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "response": "string"
}

Download Configuration Backup

Download switch's configuration backup.

Authorizations:
path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "response": "string"
}

Restore Configuration Backup

Restore switch's configuration backup.

Authorizations:
path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Configuration Backups

List of switch's configuration backup

Authorizations:
path Parameters
switchId
required
string

switchId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Configuration Backup

Create a switch's configuration backup.

Authorizations:
path Parameters
switchId
required
string

switchId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

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

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Configuration Backup

Get a switch's configuration backup.

Authorizations:
path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "backupType": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "failureReason": "string",
  • "id": "string",
  • "name": "string",
  • "restoreStatus": "string",
  • "restoreTimestamp": "string",
  • "status": "string"
}

View

View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Clients

Get a list of switch clients (i.e., end-user devices).

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

exists
string
fields
Array of strings
object
Array of objects (MatchFieldDto)
multiSortFields
Array of strings
Array of objects (MustNotMatchFieldDto)
page
integer <int32>
object (EntryOfstringAndstring)
pageSize
integer <int32>
object (RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
object (TermFieldDto)

Responses

Request samples

Content type
application/json
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [
    ],
  • "totalCount": 0
}

Get Client

Get a list of parameters for this client.

Authorizations:
path Parameters
clientMac
required
string

Client MAC

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
"string"

Get Stack

Get a list of Switch stack members.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

Get Ports

Get a list of parameters for the switch's ports.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

exists
string
fields
Array of strings
object
Array of objects (MatchFieldDto)
multiSortFields
Array of strings
Array of objects (MustNotMatchFieldDto)
page
integer <int32>
object (EntryOfstringAndstring)
pageSize
integer <int32>
object (RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
object (TermFieldDto)

Responses

Request samples

Content type
application/json
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [
    ],
  • "totalCount": 0
}

Get switch list.

Get parameters and operational data for a list of switches.

Authorizations:
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

exists
string
fields
Array of strings
object
Array of objects (MatchFieldDto)
multiSortFields
Array of strings
Array of objects (MustNotMatchFieldDto)
page
integer <int32>
object (EntryOfstringAndstring)
pageSize
integer <int32>
object (RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
object (TermFieldDto)

Responses

Request samples

Content type
application/json
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [
    ],
  • "totalCount": 0
}

Get Switch

Get a list of parameters for this switch.

Authorizations:
path Parameters
switchId
required
string

Switch ID

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{ }

Get Port Status

Get status for each of this switch's ports.

Authorizations:
path Parameters
switchId
required
string

Switch ID

tenantId
required
string

Tenant ID

query Parameters
unitid
string

unitid

Responses

Response samples

Content type
application/json
{ }