Skip to content
/
Update Port

Switch Service API & Model Documentation (0.3.4)

Overview

Rate Limit

For the Switch REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 20 calls can be made per second.
  • Each second 10 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Terms of Service

Languages
Servers
Asian region

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

European region

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

North American region

https://api.ruckus.cloud/

AAA Server

Manage AAA (authentication, authorization, and accounting) Servers.

Operations

AAA Setting

Manage AAA (authentication, authorization, and accounting) Settings.

Operations

Command-Line Interface Template

Manage command-line interface templates.

Operations

Configuration History

Retrieve configuration history.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX Switches.

Operations

Import Switch

Import Switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles.

Operations

Profile ACL

Manage ACL (access control list) of switch profile.

Operations

Profile Template

Manage switch profile templates.

Operations

Profile VLAN

Manage VLANs (virtual local area networks) of switch profile.

Operations

Switch Access Control List

Manage ACLs (access control lists).

Operations

Switch Configuration Backup

Manage configuration backups.

Operations

Switch Firmware Upgrade

Manage firmware upgrade.

Operations

Switch Ports

Manage Ports.

Operations

Get PortsDeprecated

Request

Get switch's port settings by switch id.

Security
jwtAuth
Path
switchIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
ignoreFieldsstring
ipsgboolean
lldpEnableboolean
poeBudgetnumber(float)
poeCapabilityboolean
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeEnableboolean
poePriorityinteger(int32)
portEnableboolean
portProtectedboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
portsArray of stringsunique
revertboolean
rstpAdminEdgePortboolean
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean
stpRootGuardboolean
switchIdstring
untaggedVlanstring
taggedVlansArray of stringsunique
voiceVlaninteger(int32)
lldpQosArray of objects(LldpQosView)unique
ingressAclstring
egressAclstring
vsixIngressAclstring
vsixEgressAclstring
tagsstring
lagobject(LagView)
switchMacstring
profileNamestring
Response
{
  "id": "string",
  "name": "string",
  "dhcpSnoopingTrust": true,
  "arpInspectionTrust": true,
  "ignoreFields": "string",
  "ipsg": true,
  "lldpEnable": true,
  "poeBudget": 0.1,
  "poeCapability": true,
  "poeClass": "__NULL",
  "poeEnable": true,
  "poePriority": 0,
  "portEnable": true,
  "portProtected": true,
  "portSpeed": "__NULL",
  "ports": [
    "string"
  ],
  "revert": true,
  "rstpAdminEdgePort": true,
  "adminPtToPt": "AUTO",
  "stpBpduGuard": true,
  "stpRootGuard": true,
  "switchId": "string",
  "untaggedVlan": "string",
  "taggedVlans": [
    "string"
  ],
  "voiceVlan": 0,
  "lldpQos": [
    { … }
  ],
  "ingressAcl": "string",
  "egressAcl": "string",
  "vsixIngressAcl": "string",
  "vsixEgressAcl": "string",
  "tags": "string",
  "lag": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "switchId": "string",
    "tenantId": "string",
    "addPorts": [ … ],
    "removePorts": [ … ],
    "portVlans": [ … ],
    "portAddVlans": [ … ],
    "lastName": "string",
    "realRemove": true,
    "defaultVlanId": "string",
    "originalUntaggedVlan": "string",
    "lagViewList": [ … ]
  },
  "switchMac": "string",
  "profileName": "string"
}

Update PortDeprecated

Request

Update switch's port setting. Use activity API with request id to get the status update.

Security
jwtAuth
Path
switchIdstringrequired
Body
required
idstring
portsArray of stringsunique
namestring
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poePriorityinteger(int32)
lldpQosArray of objects(LldpQosBo)unique
taggedVlansArray of stringsunique
untaggedVlanstring
ingressAclstring
egressAclstring
tagsstring
switchSerialNumberstring
ignoreFieldsstring
poeBudgetinteger(int32)
voiceVlaninteger(int32)[ 1 .. 4095 ]
portEnableboolean
poeEnableboolean
poeCapabilityboolean
portProtectedboolean
lldpEnableboolean
rstpAdminEdgePortboolean
stpBpduGuardboolean
stpRootGuardboolean
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
ipsgboolean
revertboolean
flexibleAuthenticationEnabledboolean
authenticationCustomizeboolean
authenticationProfileIdstring
authenticationTypestring
Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
changeAuthOrderboolean
dot1xPortControlstring
Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)[ 1 .. 4095 ]
restrictedVlaninteger(int32)[ 1 .. 4095 ]
criticalVlaninteger(int32)[ 1 .. 4095 ]
guestVlaninteger(int32)[ 1 .. 4095 ]
authFailActionstring
Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring
Enum"__NULL""none""failure""success""critical_vlan"
defaultVlanobject(SwitchVlan)
switchPortProfileIdstring
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
portSecurityboolean
portSecurityMaxEntriesinteger(int32)
switchMacAclstring
poeSchedulerobject(SchedulerBo)
portSetArray of stringsunique
ignoreFieldSetArray of stringsunique
authenticationDataByProfileobject(AuthenticationProfile)
{
  "id": "string",
  "ports": [
    "string"
  ],
  "name": "string",
  "portSpeed": "__NULL",
  "poeClass": "__NULL",
  "poePriority": 0,
  "lldpQos": [
    { … }
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "ingressAcl": "string",
  "egressAcl": "string",
  "tags": "string",
  "switchSerialNumber": "string",
  "ignoreFields": "string",
  "poeBudget": 0,
  "voiceVlan": 1,
  "portEnable": true,
  "poeEnable": true,
  "poeCapability": true,
  "portProtected": true,
  "lldpEnable": true,
  "rstpAdminEdgePort": true,
  "stpBpduGuard": true,
  "stpRootGuard": true,
  "dhcpSnoopingTrust": true,
  "arpInspectionTrust": true,
  "ipsg": true,
  "revert": true,
  "flexibleAuthenticationEnabled": true,
  "authenticationCustomize": true,
  "authenticationProfileId": "string",
  "authenticationType": "__NULL",
  "changeAuthOrder": true,
  "dot1xPortControl": "__NULL",
  "authDefaultVlan": 1,
  "restrictedVlan": 1,
  "criticalVlan": 1,
  "guestVlan": 1,
  "authFailAction": "__NULL",
  "authTimeoutAction": "__NULL",
  "defaultVlan": {
    "id": "string",
    "tenant": { … },
    "vlanId": 1,
    "vlanName": "string",
    "ipv4DhcpSnooping": true,
    "ipv4DhcpSnoopingTrustPort": "string",
    "arpInspection": true,
    "arpInspectionTrustPort": "string",
    "igmpSnooping": "active",
    "multicastVersion": 3,
    "spanningTreeProtocol": "rstp",
    "spanningTreePriority": 65535,
    "switchVlanPortModels": [ … ],
    "vni": 0,
    "enableAsDefaultVlan": true,
    "usedByVePort": true,
    "notSpanningTreePriorityZeroOrStepsOf4096": true,
    "defaultVlan": true,
    "stp": true
  },
  "switchPortProfileId": "string",
  "adminPtToPt": "AUTO",
  "portSecurity": true,
  "portSecurityMaxEntries": 0,
  "switchMacAcl": "string",
  "poeScheduler": {
    "type": "NO_SCHEDULE",
    "mon": "string",
    "tue": "string",
    "wed": "string",
    "thu": "string",
    "fri": "string",
    "sat": "string",
    "sun": "string",
    "timeZone": "string"
  },
  "portSet": [
    "string"
  ],
  "ignoreFieldSet": [
    "string"
  ],
  "authenticationDataByProfile": {
    "id": "string",
    "tenant": { … },
    "profileName": "string",
    "authenticationType": "__NULL",
    "changeAuthOrder": true,
    "dot1xPortControl": "__NULL",
    "authDefaultVlan": 1,
    "restrictedVlan": 1,
    "criticalVlan": 1,
    "guestVlan": 1,
    "authFailAction": "__NULL",
    "authTimeoutAction": "__NULL"
  }
}

Responses

OK

Body
idstring
namestring
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
ignoreFieldsstring
ipsgboolean
lldpEnableboolean
poeBudgetnumber(float)
poeCapabilityboolean
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeEnableboolean
poePriorityinteger(int32)
portEnableboolean
portProtectedboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
portsArray of stringsunique
revertboolean
rstpAdminEdgePortboolean
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean
stpRootGuardboolean
switchIdstring
untaggedVlanstring
taggedVlansArray of stringsunique
voiceVlaninteger(int32)
lldpQosArray of objects(LldpQosView)unique
ingressAclstring
egressAclstring
vsixIngressAclstring
vsixEgressAclstring
tagsstring
lagobject(LagView)
switchMacstring
profileNamestring
Response
{
  "id": "string",
  "name": "string",
  "dhcpSnoopingTrust": true,
  "arpInspectionTrust": true,
  "ignoreFields": "string",
  "ipsg": true,
  "lldpEnable": true,
  "poeBudget": 0.1,
  "poeCapability": true,
  "poeClass": "__NULL",
  "poeEnable": true,
  "poePriority": 0,
  "portEnable": true,
  "portProtected": true,
  "portSpeed": "__NULL",
  "ports": [
    "string"
  ],
  "revert": true,
  "rstpAdminEdgePort": true,
  "adminPtToPt": "AUTO",
  "stpBpduGuard": true,
  "stpRootGuard": true,
  "switchId": "string",
  "untaggedVlan": "string",
  "taggedVlans": [
    "string"
  ],
  "voiceVlan": 0,
  "lldpQos": [
    { … }
  ],
  "ingressAcl": "string",
  "egressAcl": "string",
  "vsixIngressAcl": "string",
  "vsixEgressAcl": "string",
  "tags": "string",
  "lag": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "switchId": "string",
    "tenantId": "string",
    "addPorts": [ … ],
    "removePorts": [ … ],
    "portVlans": [ … ],
    "portAddVlans": [ … ],
    "lastName": "string",
    "realRemove": true,
    "defaultVlanId": "string",
    "originalUntaggedVlan": "string",
    "lagViewList": [ … ]
  },
  "switchMac": "string",
  "profileName": "string"
}

Get PortsDeprecated

Request

Get switch's port settings with port ids.

Security
jwtAuth
Path
switchIdstringrequired
Body
requiredArray [
string
]
[
  "string"
]

Responses

OK

Body
idstring
namestring
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
ignoreFieldsstring
ipsgboolean
lldpEnableboolean
poeBudgetnumber(float)
poeCapabilityboolean
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeEnableboolean
poePriorityinteger(int32)
portEnableboolean
portProtectedboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
portsArray of stringsunique
revertboolean
rstpAdminEdgePortboolean
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean
stpRootGuardboolean
switchIdstring
untaggedVlanstring
taggedVlansArray of stringsunique
voiceVlaninteger(int32)
lldpQosArray of objects(LldpQosView)unique
ingressAclstring
egressAclstring
vsixIngressAclstring
vsixEgressAclstring
tagsstring
lagobject(LagView)
switchMacstring
profileNamestring
Response
{
  "id": "string",
  "name": "string",
  "dhcpSnoopingTrust": true,
  "arpInspectionTrust": true,
  "ignoreFields": "string",
  "ipsg": true,
  "lldpEnable": true,
  "poeBudget": 0.1,
  "poeCapability": true,
  "poeClass": "__NULL",
  "poeEnable": true,
  "poePriority": 0,
  "portEnable": true,
  "portProtected": true,
  "portSpeed": "__NULL",
  "ports": [
    "string"
  ],
  "revert": true,
  "rstpAdminEdgePort": true,
  "adminPtToPt": "AUTO",
  "stpBpduGuard": true,
  "stpRootGuard": true,
  "switchId": "string",
  "untaggedVlan": "string",
  "taggedVlans": [
    "string"
  ],
  "voiceVlan": 0,
  "lldpQos": [
    { … }
  ],
  "ingressAcl": "string",
  "egressAcl": "string",
  "vsixIngressAcl": "string",
  "vsixEgressAcl": "string",
  "tags": "string",
  "lag": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "switchId": "string",
    "tenantId": "string",
    "addPorts": [ … ],
    "removePorts": [ … ],
    "portVlans": [ … ],
    "portAddVlans": [ … ],
    "lastName": "string",
    "realRemove": true,
    "defaultVlanId": "string",
    "originalUntaggedVlan": "string",
    "lagViewList": [ … ]
  },
  "switchMac": "string",
  "profileName": "string"
}

Update PortsDeprecated

Request

Update ports of different switches. Use activity API with request id to get the status update.

Security
jwtAuth
Body
requiredArray [
switchIdstring
]
[
  {
    "switchId": "string"
  }
]

Responses

OK

Body
idstring
namestring
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
ignoreFieldsstring
ipsgboolean
lldpEnableboolean
poeBudgetnumber(float)
poeCapabilityboolean
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeEnableboolean
poePriorityinteger(int32)
portEnableboolean
portProtectedboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
portsArray of stringsunique
revertboolean
rstpAdminEdgePortboolean
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean
stpRootGuardboolean
switchIdstring
untaggedVlanstring
taggedVlansArray of stringsunique
voiceVlaninteger(int32)
lldpQosArray of objects(LldpQosView)unique
ingressAclstring
egressAclstring
vsixIngressAclstring
vsixEgressAclstring
tagsstring
lagobject(LagView)
switchMacstring
profileNamestring
Response
{
  "id": "string",
  "name": "string",
  "dhcpSnoopingTrust": true,
  "arpInspectionTrust": true,
  "ignoreFields": "string",
  "ipsg": true,
  "lldpEnable": true,
  "poeBudget": 0.1,
  "poeCapability": true,
  "poeClass": "__NULL",
  "poeEnable": true,
  "poePriority": 0,
  "portEnable": true,
  "portProtected": true,
  "portSpeed": "__NULL",
  "ports": [
    "string"
  ],
  "revert": true,
  "rstpAdminEdgePort": true,
  "adminPtToPt": "AUTO",
  "stpBpduGuard": true,
  "stpRootGuard": true,
  "switchId": "string",
  "untaggedVlan": "string",
  "taggedVlans": [
    "string"
  ],
  "voiceVlan": 0,
  "lldpQos": [
    { … }
  ],
  "ingressAcl": "string",
  "egressAcl": "string",
  "vsixIngressAcl": "string",
  "vsixEgressAcl": "string",
  "tags": "string",
  "lag": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "switchId": "string",
    "tenantId": "string",
    "addPorts": [ … ],
    "removePorts": [ … ],
    "portVlans": [ … ],
    "portAddVlans": [ … ],
    "lastName": "string",
    "realRemove": true,
    "defaultVlanId": "string",
    "originalUntaggedVlan": "string",
    "lagViewList": [ … ]
  },
  "switchMac": "string",
  "profileName": "string"
}

Get PortsDeprecated

Request

Get port settings of different switches.

Security
jwtAuth
Body
requiredArray [
switchIdstring
portsArray of strings
]
[
  {
    "switchId": "string",
    "ports": [ … ]
  }
]

Responses

OK

Body
idstring
namestring
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
ignoreFieldsstring
ipsgboolean
lldpEnableboolean
poeBudgetnumber(float)
poeCapabilityboolean
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeEnableboolean
poePriorityinteger(int32)
portEnableboolean
portProtectedboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
portsArray of stringsunique
revertboolean
rstpAdminEdgePortboolean
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean
stpRootGuardboolean
switchIdstring
untaggedVlanstring
taggedVlansArray of stringsunique
voiceVlaninteger(int32)
lldpQosArray of objects(LldpQosView)unique
ingressAclstring
egressAclstring
vsixIngressAclstring
vsixEgressAclstring
tagsstring
lagobject(LagView)
switchMacstring
profileNamestring
Response
{
  "id": "string",
  "name": "string",
  "dhcpSnoopingTrust": true,
  "arpInspectionTrust": true,
  "ignoreFields": "string",
  "ipsg": true,
  "lldpEnable": true,
  "poeBudget": 0.1,
  "poeCapability": true,
  "poeClass": "__NULL",
  "poeEnable": true,
  "poePriority": 0,
  "portEnable": true,
  "portProtected": true,
  "portSpeed": "__NULL",
  "ports": [
    "string"
  ],
  "revert": true,
  "rstpAdminEdgePort": true,
  "adminPtToPt": "AUTO",
  "stpBpduGuard": true,
  "stpRootGuard": true,
  "switchId": "string",
  "untaggedVlan": "string",
  "taggedVlans": [
    "string"
  ],
  "voiceVlan": 0,
  "lldpQos": [
    { … }
  ],
  "ingressAcl": "string",
  "egressAcl": "string",
  "vsixIngressAcl": "string",
  "vsixEgressAcl": "string",
  "tags": "string",
  "lag": {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "switchId": "string",
    "tenantId": "string",
    "addPorts": [ … ],
    "removePorts": [ … ],
    "portVlans": [ … ],
    "portAddVlans": [ … ],
    "lastName": "string",
    "realRemove": true,
    "defaultVlanId": "string",
    "originalUntaggedVlan": "string",
    "lagViewList": [ … ]
  },
  "switchMac": "string",
  "profileName": "string"
}

Switch Static Routes

Manage static routes.

Operations

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Operations

Trusted Port

Manage a port's trust settings.

Operations

Venue Switch Setting

Manage a switch's venue-level settings.

Operations

Venue Template AAA Server

Manage Venue Template AAA (authentication, authorization, and accounting) Servers.

Operations

Venue Template AAA Setting

Manage Venue Template AAA (authentication, authorization, and accounting) Settings.

Operations