Documentation Powered by ReDoc

Ruckus Cloud - Switch API and Model Documentation (v21.01.11)

License: Ruckus Cloud Privacy Policy Terms of Service

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.

Cloud hosts: North American region: "https://ruckus.cloud", European region: "https://eu.ruckus.cloud", Asian region: "https://asia.ruckus.cloud".

New Endpoints in Release

New API Endpoints in Existing Groups

API GroupNew SummaryNew Description
IcxSwitchGet Route TableGet this switch's routing table.

IcxSwitch

Manage ICX Switches.

Get Switches

List of tenant's Switches

path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Switch

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

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

default: 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
ipAddressType
string
Enum: "static" "dynamic"
isPrimaryDeleted
boolean

default: false

jumboMode
boolean

default: false

name
string^(?:(?!").){1,255}$
object (SwitchPosition)

Switch Position object

sendedHostname
boolean

default: false

softDeleted
boolean

default: false

softDeletedDate
string <date-time>
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
Array of objects (StackMembers)
subnetMask
string
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",
  • "ipAddressType": "static",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "name": "string",
  • "position": {
    },
  • "sendedHostname": true,
  • "softDeleted": true,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "tags": "string",
  • "venueId": "string"
}

Response samples

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

Update Switch

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

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

default: 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
ipAddressType
string
Enum: "static" "dynamic"
isPrimaryDeleted
boolean

default: false

jumboMode
boolean

default: false

name
string^(?:(?!").){1,255}$
object (SwitchPosition)

Switch Position object

sendedHostname
boolean

default: false

softDeleted
boolean

default: false

softDeletedDate
string <date-time>
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
Array of objects (StackMembers)
subnetMask
string
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",
  • "ipAddressType": "static",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "name": "string",
  • "position": {
    },
  • "sendedHostname": true,
  • "softDeleted": true,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "tags": "string",
  • "venueId": "string"
}

Response samples

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

Get Switches By Venue

List of Switches under a venue

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Switch

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",
  • "ipAddressType": "static",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "name": "string",
  • "position": {
    },
  • "sendedHostname": true,
  • "softDeleted": true,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "tags": "string",
  • "venueId": "string"
}

Delete Switch

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

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

Ack

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

add
Array of strings
remove
Array of strings

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "remove": [
    ]
}

Response samples

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

Add Member

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

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

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

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

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

Get Route Table

Get this switch's routing table.

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

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

Trace Route

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

Upgrade Firmware

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 Switches

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

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

default: 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
ipAddressType
string
Enum: "static" "dynamic"
isPrimaryDeleted
boolean

default: false

jumboMode
boolean

default: false

name
string^(?:(?!").){1,255}$
object (SwitchPosition)

Switch Position object

sendedHostname
boolean

default: false

softDeleted
boolean

default: false

softDeletedDate
string <date-time>
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
Array of objects (StackMembers)
subnetMask
string
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 Switches

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

StackMembers

Manage stack members.

Get Stack Members

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Stack Member

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

path Parameters
stackSwitchSerialNumber
required
string

stackSwitchSerialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

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

Profile

Manage switch profiles.

Add Profile

Add Profile

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array of objects (Acl)

default: new HashSet()

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

default: new HashSet()

venues
Array of strings
Array of objects (Vlan)

default: new HashSet()

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

Update Profile

Update Profile

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array of objects (Acl)

default: new HashSet()

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

default: new HashSet()

venues
Array of strings
Array of objects (Vlan)

default: new HashSet()

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

Profile

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 Profile

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

path Parameters
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Profiles

Delete Profile

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

Get Profiles By Venue

List of tenant's profiles by Venue Id

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

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

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

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 By Serial Number

List of Switch's port settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Port

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

deviceId
string
dhcpSnoopingTrust
boolean

default: false

egressAcl
string
id
string
ignoreFields
string
ingressAcl
string
ipsg
boolean

default: false

object (Lag)

domain object representing LAG Model

lldpEnable
boolean

default: true

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

default: true

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

default: true

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

default: true

portProtected
boolean

default: 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"
ports
Array of strings
revert
boolean

default: false

rstpAdminEdgePort
boolean

default: false

stpBpduGuard
boolean

default: false

stpRootGuard
boolean

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

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

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 Ports Among Switches

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

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": [
    ]
}

TrustedPort

Manage a port's trust settings.

Get Trusted Ports By Venue

List of TrustedPort under a venue

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Trusted Port

Add TrustedPort

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)

default: new HashSet()

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

default: TrustedPortTypeEnum.all

vlanDemand
boolean

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

Update Trusted Port

Update TrustedPort

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)

default: new HashSet()

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

default: TrustedPortTypeEnum.all

vlanDemand
boolean

default: 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 TrustedPort

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 TrustedPort

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

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

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

Get LAGs By Serial Number

List of Switch's LAG settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add LAG

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

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

path Parameters
lagId
required
string

lagId

tenantId
required
string

Tenant ID

Responses

Response samples

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

Add LAGs

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

List of VLAN under a venue

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get VLANs By Venue And Model

List of VLAN under a venue with specific model

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

List of VLAN under a venue with specific model and tagged port

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

List of VLAN under a venue with specific model and untagged port

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
[
  • {
    }
]

Add VLAN

Add VLAN

path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

arpInspection
boolean

default: false

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

default: 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)

default: new HashSet()

vlanId
integer <int32> [ 1 .. 4094 ]
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": {
    }
}

Update VLAN

Update VLAN

path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

arpInspection
boolean

default: false

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

default: 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)

default: new HashSet()

vlanId
integer <int32> [ 1 .. 4094 ]
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

Vlan

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 VLAN

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 VLAN under a profile

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 VLANs

path Parameters
profileId
required
string

profileId

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

SwitchVlan

Manage switch-level VLANs.

Get Default VLAN By Serial Numbers

Get Switch's default VLAN Id

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

Get All VLAN Intersection of Switch

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

Get All VLAN Union of Switch

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

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

VePort

Manage VE (virtual Ethernet) port settings.

Update VE Port

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

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

Responses

Request samples

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

Response samples

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

Get VE Ports By Serial Number

List of Switch's VePort settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add VE Port

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

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

Responses

Request samples

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

Response samples

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

Get VE Port

path Parameters
tenantId
required
string

Tenant ID

vePortId
required
string

vePortId

Responses

Response samples

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

Delete VE Port

path Parameters
tenantId
required
string

Tenant ID

vePortId
required
string

vePortId

Responses

Response samples

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

Delete VE Ports

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

Add VE Ports

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array ()
dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipAddressType
string
Enum: "static" "dynamic"
ipSubnetMask
string
name
string
ospfArea
string
veId
integer <int32>
vlanId
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

StaticRoute

Manage static routes.

Update Static Route

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 By Serial Number

List of Switch's StaticRoute settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Static Route

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

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

path Parameters
staticRouteId
required
string

staticRouteId

tenantId
required
string

Tenant ID

Responses

Response samples

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

Delete Static Routes

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

Add Static Routes

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

List of ACL under a venue

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Acl

Add Acl

path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array of objects (AclRule)

default: new HashSet()

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

Update Acl

Update Acl

path Parameters
profileId
required
string

profileId

tenantId
required
string

Tenant ID

Request Body schema: application/json

viewInput

Array of objects (AclRule)

default: new HashSet()

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

Acl

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 Acl

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 Acl under a profile

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 Acls

path Parameters
profileId
required
string

profileId

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

ConfigBackup

Manage configuration backups.

Delete Config Backups

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

Compare Config Backups

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 Config Backup Full Content

path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Responses

Response samples

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

Download Config Backup

path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Responses

Response samples

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

Restore Config Backup

path Parameters
id
required
string

id

tenantId
required
string

Tenant ID

Responses

Response samples

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

Get Config Backups By Switch Id

List of Switch's Backup Configurations

path Parameters
switchId
required
string

switchId

tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Config Backup

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

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

path Parameters
tenant_id
required
string

Tenant ID

Request Body schema: application/json

payload

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
{
  • "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.

path Parameters
client_mac
required
string

Client MAC

tenant_id
required
string

Tenant ID

Responses

Response samples

Content type
application/json
"string"

Get Stack

Get a list of Switch stack members.

path Parameters
tenant_id
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.

path Parameters
tenant_id
required
string

Tenant ID

Request Body schema: application/json

payload

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
{
  • "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 Switches

Get a list of Switches.

path Parameters
tenant_id
required
string

Tenant ID

Request Body schema: application/json

payload

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
{
  • "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.

path Parameters
switch_id
required
string

Switch ID

tenant_id
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{ }

Get Ports' Status

Get status for each of this Switch's ports.

path Parameters
switch_id
required
string

Switch ID

tenant_id
required
string

Tenant ID

query Parameters
unitid
string

unitid

Responses

Response samples

Content type
application/json
{ }