Skip to content
Switch Services/
/
Update ICX Switch

Switch Services (0.4.0)

Overview

The Switch Service REST API facilitates the management and configuration of RUCKUS ICX switches via the RUCKUS One platform. This API allows for programmatic control of switch operations, network configurations, security policies, and monitoring across various environments.

What This API Does

  • Manage ICX switch devices and their configurations
  • Configure network settings including VLANs, ports, LAGs, and virtual ethernet interfaces
  • Control security policies with AAA servers, ACLs, and trusted port settings
  • Create and apply switch profiles and templates for consistent configurations
  • Handle firmware upgrades and configuration backups
  • Configure DHCP servers and static routing
  • Import and onboard new switches to the platform
  • Manage CLI templates and web authentication pages

Authentication

All API calls require valid authentication via JWT (JSON Web Token) in Authorization header.

Regional Endpoints

Select the appropriate API endpoint based on your region:

  • North America: https://api.ruckus.cloud
  • Europe: https://api.eu.ruckus.cloud
  • Asia: https://api.asia.ruckus.cloud

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors.
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Terms of Service
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

AAA Server

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

Operations

AAA Setting

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

Operations

Command Line Interface Template

Manage command line interface templates.

Operations

Configuration History

Retrieve switch configuration history records.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX switch settings.

Operations

Get ICX SwitchDeprecated

Request

Get ICX switch by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId} can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

venueIdstring

The unique identifier of the venue where the switch is located.

namestring

The name assigned to the ICX switch for identification in the network.

descriptionstring

The descriptive text providing additional information about the switch configuration or purpose.

tagsstring

The comma separated list of custom tags assigned to this switch for organization and filtering.

enableStackboolean

The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.

igmpSnoopingstring

The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.

Enum"active""passive""none"
jumboModeboolean

The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.

positionobject(SwitchPosition_V1)

The physical location information of the switch including building, floor, and coordinates.

spanningTreePriorityinteger(int32)

The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).

softDeletedDatestring(date-time)

The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.

stackMembersArray of objects(StackMembers_V1)

The list of member switches in a stack configuration, including their models and active status.

ipAddressInterfaceTypestring

The interface type for the switch management IP address: VLAN interface or management port.

Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring

The specific interface identifier for the management IP address configuration.

ipAddressTypestring

The IP address assignment method: static or DHCP.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to the switch management interface.

subnetMaskstring

The subnet mask for the switch management IP address.

defaultGatewaystring

The default gateway IP address for routing traffic from the switch management interface.

firmwareVersionstring

The current firmware version running on the switch.

previousMembersArray of stringsunique

The set of serial numbers for previous stack members that have been removed from the stack.

lastDataSyncTriggerTimeinteger(int64)

The timestamp in milliseconds when the last data synchronization was triggered for this switch.

lastDataSyncTimeinteger(int64)

The timestamp in milliseconds when the last data synchronization completed for this switch.

syncDataIdstring

The unique identifier for the current data synchronization operation.

syncDataStartTimeinteger(int64)

The timestamp in milliseconds when the current data synchronization operation started.

syncDataEndTimeinteger(int64)

The timestamp in milliseconds when the current data synchronization operation ended.

dhcpClientEnabledboolean

The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.

dhcpServerEnabledboolean

The flag indicating whether the DHCP server feature is enabled on the switch.

trustPortsArray of strings

The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.

initialVlanIdinteger(int32)

The VLAN ID used for initial switch configuration and management access.

stackConfigTimestampstring

The timestamp indicating when the stack configuration was last modified.

specifiedTypestring

The firmware image type specified for the switch: primary, secondary, or boot.

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

The model identifier of the rear expansion module installed on the switch, if applicable.

vlanCustomizeboolean

The flag indicating whether VLAN configurations have been customized from default settings.

Response
{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "description": "string",
  "tags": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "position": {
    "id": "string",
    "floorplanId": "string",
    "xPercent": 0.1,
    "yPercent": 0.1
  },
  "spanningTreePriority": 0,
  "softDeletedDate": "2019-08-24T14:15:22Z",
  "stackMembers": [
    { … }
  ],
  "ipAddressInterfaceType": "NONE",
  "ipAddressInterface": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "subnetMask": "string",
  "defaultGateway": "string",
  "firmwareVersion": "string",
  "previousMembers": [
    "string"
  ],
  "lastDataSyncTriggerTime": 0,
  "lastDataSyncTime": 0,
  "syncDataId": "string",
  "syncDataStartTime": 0,
  "syncDataEndTime": 0,
  "dhcpClientEnabled": true,
  "dhcpServerEnabled": true,
  "trustPorts": [
    "string"
  ],
  "initialVlanId": 0,
  "stackConfigTimestamp": "string",
  "specifiedType": "AUTO",
  "rearModule": "string",
  "vlanCustomize": true
}

Update ICX SwitchDeprecated

Request

Update ICX switch. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId} can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
Body
required
idstring

Unique identifier for the switch (typically the serial number).

modelstring

Switch model (e.g., ICX7150, ICX7250, ICX7450).

Enum"ICX7150-24""ICX7150-24P""ICX7150-48""ICX7150-48P""ICX7150-48PF""ICX7150-48ZP""ICX7150-C12P""ICX7150-C10ZP""ICX7150-C08P""ICX7150-C08PT"
venueIdstring

Venue identifier where the switch will be registered.

initialVlanIdinteger(int32)

Initial VLAN ID for the switch management interface.

enableStackboolean

Flag indicating whether stacking is enabled on this switch.

defaultGatewaystring

Default gateway IP address for the switch management interface.

descriptionstring

Description or notes for the switch.

dhcpClientEnabledboolean

Flag indicating whether DHCP client is enabled for obtaining IP address (default: true).

dhcpServerEnabledboolean

Flag indicating whether DHCP server is enabled on the switch (default: false).

firmwareVersionstring

Current firmware version installed on the switch.

igmpSnoopingstring

IGMP snooping configuration status (e.g., enabled, disabled).

ipAddressstring

Static IP address assigned to the switch management interface.

ipAddressInterfacestring

Interface name or number for the IP address assignment (e.g., ve1, ethernet1/1/1).

ipAddressInterfaceTypestring

Type of interface for IP address assignment (e.g., VE, ETHERNET).

ipAddressTypestring

IP address assignment type (static or dynamic).

Enum"static""dynamic"
jumboModeboolean

Flag indicating whether jumbo frame mode is enabled (default: false).

lastDataSyncTimestring(date-time)

Timestamp of the last successful data synchronization from the switch.

lastDataSyncTriggerTimestring(date-time)

Timestamp when the last data synchronization was triggered.

namestring

Name or hostname for the switch.

positionstring

Physical position or location description of the switch.

previousMembersArray of stringsunique

Set of serial numbers of previous stack members.

softDeletedDatestring(date-time)

Timestamp when the switch was soft deleted (marked for deletion).

spanningTreePriorityinteger(int32)

STP (Spanning Tree Protocol) priority value for this switch (0-61440, in increments of 4096).

stackConfigTimestampstring

Timestamp of the last stack configuration change.

stackMembersArray of objects(StackMembers)

List of stack member information if this is a stacked switch.

displayOfStackstring

Display string representing the stack configuration.

subnetMaskstring

Subnet mask for the switch management interface.

syncDataEndTimestring(date-time)

End time of the data synchronization process.

syncDataIdstring

Unique identifier for the data synchronization session.

syncDataStartTimestring(date-time)

Start time of the data synchronization process.

tagsstring

Comma separated tags for categorizing or labeling the switch.

trustPortsArray of strings

List of trusted ports for DHCP snooping (e.g., ['1/1/1', '1/1/2']).

specifiedTypestring

Specified firmware image type for the switch (e.g., ROUTER, SWITCH).

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

Rear module configuration for the switch (e.g., 'none', 'stack-40g' for ICX7650).

vlanCustomizeboolean

Flag indicating whether VLAN configuration is customized (non default).

{
  "id": "string",
  "model": "ICX7150-24",
  "venueId": "string",
  "initialVlanId": 0,
  "enableStack": true,
  "defaultGateway": "string",
  "description": "string",
  "dhcpClientEnabled": true,
  "dhcpServerEnabled": true,
  "firmwareVersion": "string",
  "igmpSnooping": "string",
  "ipAddress": "string",
  "ipAddressInterface": "string",
  "ipAddressInterfaceType": "string",
  "ipAddressType": "static",
  "jumboMode": true,
  "lastDataSyncTime": "2019-08-24T14:15:22Z",
  "lastDataSyncTriggerTime": "2019-08-24T14:15:22Z",
  "name": "string",
  "position": "string",
  "previousMembers": [
    "string"
  ],
  "softDeletedDate": "2019-08-24T14:15:22Z",
  "spanningTreePriority": 0,
  "stackConfigTimestamp": "string",
  "stackMembers": [
    { … }
  ],
  "displayOfStack": "string",
  "subnetMask": "string",
  "syncDataEndTime": "2019-08-24T14:15:22Z",
  "syncDataId": "string",
  "syncDataStartTime": "2019-08-24T14:15:22Z",
  "tags": "string",
  "trustPorts": [
    "string"
  ],
  "specifiedType": "AUTO",
  "rearModule": "string",
  "vlanCustomize": true
}

Responses

OK

Body
idstring

The identifier

venueIdstring

The unique identifier of the venue where the switch is located.

namestring

The name assigned to the ICX switch for identification in the network.

descriptionstring

The descriptive text providing additional information about the switch configuration or purpose.

tagsstring

The comma separated list of custom tags assigned to this switch for organization and filtering.

enableStackboolean

The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.

igmpSnoopingstring

The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.

Enum"active""passive""none"
jumboModeboolean

The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.

positionobject(SwitchPosition_V1)

The physical location information of the switch including building, floor, and coordinates.

spanningTreePriorityinteger(int32)

The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).

softDeletedDatestring(date-time)

The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.

stackMembersArray of objects(StackMembers_V1)

The list of member switches in a stack configuration, including their models and active status.

ipAddressInterfaceTypestring

The interface type for the switch management IP address: VLAN interface or management port.

Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring

The specific interface identifier for the management IP address configuration.

ipAddressTypestring

The IP address assignment method: static or DHCP.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to the switch management interface.

subnetMaskstring

The subnet mask for the switch management IP address.

defaultGatewaystring

The default gateway IP address for routing traffic from the switch management interface.

firmwareVersionstring

The current firmware version running on the switch.

previousMembersArray of stringsunique

The set of serial numbers for previous stack members that have been removed from the stack.

lastDataSyncTriggerTimeinteger(int64)

The timestamp in milliseconds when the last data synchronization was triggered for this switch.

lastDataSyncTimeinteger(int64)

The timestamp in milliseconds when the last data synchronization completed for this switch.

syncDataIdstring

The unique identifier for the current data synchronization operation.

syncDataStartTimeinteger(int64)

The timestamp in milliseconds when the current data synchronization operation started.

syncDataEndTimeinteger(int64)

The timestamp in milliseconds when the current data synchronization operation ended.

dhcpClientEnabledboolean

The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.

dhcpServerEnabledboolean

The flag indicating whether the DHCP server feature is enabled on the switch.

trustPortsArray of strings

The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.

initialVlanIdinteger(int32)

The VLAN ID used for initial switch configuration and management access.

stackConfigTimestampstring

The timestamp indicating when the stack configuration was last modified.

specifiedTypestring

The firmware image type specified for the switch: primary, secondary, or boot.

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

The model identifier of the rear expansion module installed on the switch, if applicable.

vlanCustomizeboolean

The flag indicating whether VLAN configurations have been customized from default settings.

Response
{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "description": "string",
  "tags": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "position": {
    "id": "string",
    "floorplanId": "string",
    "xPercent": 0.1,
    "yPercent": 0.1
  },
  "spanningTreePriority": 0,
  "softDeletedDate": "2019-08-24T14:15:22Z",
  "stackMembers": [
    { … }
  ],
  "ipAddressInterfaceType": "NONE",
  "ipAddressInterface": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "subnetMask": "string",
  "defaultGateway": "string",
  "firmwareVersion": "string",
  "previousMembers": [
    "string"
  ],
  "lastDataSyncTriggerTime": 0,
  "lastDataSyncTime": 0,
  "syncDataId": "string",
  "syncDataStartTime": 0,
  "syncDataEndTime": 0,
  "dhcpClientEnabled": true,
  "dhcpServerEnabled": true,
  "trustPorts": [
    "string"
  ],
  "initialVlanId": 0,
  "stackConfigTimestamp": "string",
  "specifiedType": "AUTO",
  "rearModule": "string",
  "vlanCustomize": true
}

Delete ICX SwitchDeprecated

Request

Delete ICX switch by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId} can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

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

Get ICX SwitchesDeprecated

Request

List of tenant's ICX switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches can be used for this content.

Security
jwtAuth
No request payload

Responses

OK

Body
idstring

The identifier

venueIdstring

The unique identifier of the venue where the switch is located.

namestring

The name assigned to the ICX switch for identification in the network.

descriptionstring

The descriptive text providing additional information about the switch configuration or purpose.

tagsstring

The comma separated list of custom tags assigned to this switch for organization and filtering.

enableStackboolean

The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.

igmpSnoopingstring

The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.

Enum"active""passive""none"
jumboModeboolean

The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.

positionobject(SwitchPosition_V1)

The physical location information of the switch including building, floor, and coordinates.

spanningTreePriorityinteger(int32)

The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).

softDeletedDatestring(date-time)

The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.

stackMembersArray of objects(StackMembers_V1)

The list of member switches in a stack configuration, including their models and active status.

ipAddressInterfaceTypestring

The interface type for the switch management IP address: VLAN interface or management port.

Enum"NONE""PORT""VE""MANAGEMENT"
ipAddressInterfacestring

The specific interface identifier for the management IP address configuration.

ipAddressTypestring

The IP address assignment method: static or DHCP.

Enum"static""dynamic"
ipAddressstring

The IPv4 address assigned to the switch management interface.

subnetMaskstring

The subnet mask for the switch management IP address.

defaultGatewaystring

The default gateway IP address for routing traffic from the switch management interface.

firmwareVersionstring

The current firmware version running on the switch.

previousMembersArray of stringsunique

The set of serial numbers for previous stack members that have been removed from the stack.

lastDataSyncTriggerTimeinteger(int64)

The timestamp in milliseconds when the last data synchronization was triggered for this switch.

lastDataSyncTimeinteger(int64)

The timestamp in milliseconds when the last data synchronization completed for this switch.

syncDataIdstring

The unique identifier for the current data synchronization operation.

syncDataStartTimeinteger(int64)

The timestamp in milliseconds when the current data synchronization operation started.

syncDataEndTimeinteger(int64)

The timestamp in milliseconds when the current data synchronization operation ended.

dhcpClientEnabledboolean

The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.

dhcpServerEnabledboolean

The flag indicating whether the DHCP server feature is enabled on the switch.

trustPortsArray of strings

The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.

initialVlanIdinteger(int32)

The VLAN ID used for initial switch configuration and management access.

stackConfigTimestampstring

The timestamp indicating when the stack configuration was last modified.

specifiedTypestring

The firmware image type specified for the switch: primary, secondary, or boot.

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

The model identifier of the rear expansion module installed on the switch, if applicable.

vlanCustomizeboolean

The flag indicating whether VLAN configurations have been customized from default settings.

Response
{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "description": "string",
  "tags": "string",
  "enableStack": true,
  "igmpSnooping": "active",
  "jumboMode": true,
  "position": {
    "id": "string",
    "floorplanId": "string",
    "xPercent": 0.1,
    "yPercent": 0.1
  },
  "spanningTreePriority": 0,
  "softDeletedDate": "2019-08-24T14:15:22Z",
  "stackMembers": [
    { … }
  ],
  "ipAddressInterfaceType": "NONE",
  "ipAddressInterface": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "subnetMask": "string",
  "defaultGateway": "string",
  "firmwareVersion": "string",
  "previousMembers": [
    "string"
  ],
  "lastDataSyncTriggerTime": 0,
  "lastDataSyncTime": 0,
  "syncDataId": "string",
  "syncDataStartTime": 0,
  "syncDataEndTime": 0,
  "dhcpClientEnabled": true,
  "dhcpServerEnabled": true,
  "trustPorts": [
    "string"
  ],
  "initialVlanId": 0,
  "stackConfigTimestamp": "string",
  "specifiedType": "AUTO",
  "rearModule": "string",
  "vlanCustomize": true
}

Add ICX SwitchesDeprecated

Request

Add multiple ICX switches. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches can be used for this content.

Security
jwtAuth
Body
requiredArray [
idstring

Unique identifier for the switch (typically the serial number).

modelstring

Switch model (e.g., ICX7150, ICX7250, ICX7450).

Enum"ICX7150-24""ICX7150-24P""ICX7150-48""ICX7150-48P""ICX7150-48PF""ICX7150-48ZP""ICX7150-C12P""ICX7150-C10ZP""ICX7150-C08P""ICX7150-C08PT"
venueIdstring

Venue identifier where the switch will be registered.

initialVlanIdinteger(int32)

Initial VLAN ID for the switch management interface.

enableStackboolean

Flag indicating whether stacking is enabled on this switch.

defaultGatewaystring

Default gateway IP address for the switch management interface.

descriptionstring

Description or notes for the switch.

dhcpClientEnabledboolean

Flag indicating whether DHCP client is enabled for obtaining IP address (default: true).

dhcpServerEnabledboolean

Flag indicating whether DHCP server is enabled on the switch (default: false).

firmwareVersionstring

Current firmware version installed on the switch.

igmpSnoopingstring

IGMP snooping configuration status (e.g., enabled, disabled).

ipAddressstring

Static IP address assigned to the switch management interface.

ipAddressInterfacestring

Interface name or number for the IP address assignment (e.g., ve1, ethernet1/1/1).

ipAddressInterfaceTypestring

Type of interface for IP address assignment (e.g., VE, ETHERNET).

ipAddressTypestring

IP address assignment type (static or dynamic).

Enum"static""dynamic"
jumboModeboolean

Flag indicating whether jumbo frame mode is enabled (default: false).

lastDataSyncTimestring(date-time)

Timestamp of the last successful data synchronization from the switch.

lastDataSyncTriggerTimestring(date-time)

Timestamp when the last data synchronization was triggered.

namestring

Name or hostname for the switch.

positionstring

Physical position or location description of the switch.

previousMembersArray of stringsunique

Set of serial numbers of previous stack members.

softDeletedDatestring(date-time)

Timestamp when the switch was soft deleted (marked for deletion).

spanningTreePriorityinteger(int32)

STP (Spanning Tree Protocol) priority value for this switch (0-61440, in increments of 4096).

stackConfigTimestampstring

Timestamp of the last stack configuration change.

stackMembersArray of objects(StackMembers)

List of stack member information if this is a stacked switch.

displayOfStackstring

Display string representing the stack configuration.

subnetMaskstring

Subnet mask for the switch management interface.

syncDataEndTimestring(date-time)

End time of the data synchronization process.

syncDataIdstring

Unique identifier for the data synchronization session.

syncDataStartTimestring(date-time)

Start time of the data synchronization process.

tagsstring

Comma separated tags for categorizing or labeling the switch.

trustPortsArray of strings

List of trusted ports for DHCP snooping (e.g., ['1/1/1', '1/1/2']).

specifiedTypestring

Specified firmware image type for the switch (e.g., ROUTER, SWITCH).

Enum"AUTO""SWITCH""ROUTER"
rearModulestring

Rear module configuration for the switch (e.g., 'none', 'stack-40g' for ICX7650).

vlanCustomizeboolean

Flag indicating whether VLAN configuration is customized (non default).

]
[
  {
    "id": "string",
    "model": "ICX7150-24",
    "venueId": "string",
    "initialVlanId": 0,
    "enableStack": true,
    "defaultGateway": "string",
    "description": "string",
    "dhcpClientEnabled": true,
    "dhcpServerEnabled": true,
    "firmwareVersion": "string",
    "igmpSnooping": "string",
    "ipAddress": "string",
    "ipAddressInterface": "string",
    "ipAddressInterfaceType": "string",
    "ipAddressType": "static",
    "jumboMode": true,
    "lastDataSyncTime": "2019-08-24T14:15:22Z",
    "lastDataSyncTriggerTime": "2019-08-24T14:15:22Z",
    "name": "string",
    "position": "string",
    "previousMembers": [ … ],
    "softDeletedDate": "2019-08-24T14:15:22Z",
    "spanningTreePriority": 0,
    "stackConfigTimestamp": "string",
    "stackMembers": [ … ],
    "displayOfStack": "string",
    "subnetMask": "string",
    "syncDataEndTime": "2019-08-24T14:15:22Z",
    "syncDataId": "string",
    "syncDataStartTime": "2019-08-24T14:15:22Z",
    "tags": "string",
    "trustPorts": [ … ],
    "specifiedType": "AUTO",
    "rearModule": "string",
    "vlanCustomize": true
  }
]

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

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

Delete ICX SwitchesDeprecated

Request

Delete multiple ICX switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches can be used for this content.

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

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

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

Sync or Reboot ICX DeviceDeprecated

Request

Execute sync or reboot command on the specified switch device, no need to provide switch id list on the request body. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/deviceRequests can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
Body
required
deviceRequestActionstring

Action to be performed on the specified devices (e.g., reboot, upgrade, delete).

Enum"sync""reboot""syncAdminPassword"
switchIdListArray of strings

List of switch identifiers (serial numbers or IDs) to perform the action on.

{
  "deviceRequestAction": "sync",
  "switchIdList": [
    "string"
  ]
}

Responses

OK

Body
requestIdstring

Unique identifier for tracking the request.

errorsArray of objects(ErrorCode)

List of error codes with detailed information about validation or processing failures.

Response
{
  "requestId": "string",
  "errors": [
    { … }
  ]
}

Create Multiple Device RequestsDeprecated

Request

Execute sync venues admin password on multiple switch devices, switch id list should be provided on the request body. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/deviceRequests can be used for this content.

Security
jwtAuth
Body
required
deviceRequestActionstring

Action to be performed on the specified devices (e.g., reboot, upgrade, delete).

Enum"sync""reboot""syncAdminPassword"
switchIdListArray of strings

List of switch identifiers (serial numbers or IDs) to perform the action on.

{
  "deviceRequestAction": "sync",
  "switchIdList": [
    "string"
  ]
}

Responses

OK

Body
idstring

The identifier

tenantIdstring

The unique identifier of the tenant for which admin passwords should be synchronized.

switchIdListArray of strings

The list of switch identifiers to which the admin password will be synchronized.

Response
{
  "id": "string",
  "tenantId": "string",
  "switchIdList": [
    "string"
  ]
}

Delete Stack MemberDeprecated

Request

Delete a specific stack member. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/stacks/{stackSwitchSerialNumber} can be used for this content.

Security
jwtAuth
Path
stackSwitchSerialNumberstringrequired
No request payload

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

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

Import Switch

Import and register new switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles and profile configurations.

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 switch configuration backups and restore operations.

Operations

Switch Firmware Upgrade

Manage switch firmware upgrade and scheduling operations.

Operations

Switch Ports

Manage switch port configurations.

Operations

Switch Static Routes

Manage static route configurations.

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