Skip to content
Switch Services/
/
Update Trusted Port

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

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

Get Trusted PortDeprecated

Request

Get the specified trusted port of the switch profile. This method will be removed no sooner than 08/31/2026.

Security
jwtAuth
Path
switchProfileIdstringrequired
trustedPortIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

trustedPortTypestring

The type of trusted port configuration: DHCP snooping or ARP inspection.

Enum"all""dhcp""arp""ipv6_dhcp""ipv6_nd"
modelstring

The switch model to which this trusted port configuration applies.

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

The flag indicating whether trusted port configuration requires VLAN specification.

trustPortsArray of strings

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

slotsArray of objects(FamilyModelSlot)unique

The set of switch family model and slot configurations for trusted port assignment across different hardware types.

Response
{
  "id": "string",
  "trustedPortType": "all",
  "model": "ICX7150-24",
  "vlanDemand": true,
  "trustPorts": [
    "string"
  ],
  "slots": [
    { … }
  ]
}

Update Trusted PortDeprecated

Request

Update the trusted port of the switch profile. This method will be removed no sooner than 08/31/2026.

Security
jwtAuth
Path
switchProfileIdstringrequired
trustedPortIdstringrequired
Body
required
idstring

Unique identifier for the trusted port configuration.

tenantIdstring

The unique identifier of the tenant.

trustedPortTypestring

Trusted port type indicating what traffic priority marking to trust (DOT1P for 802.1p, DSCP for IP DSCP).

Enum"all""dhcp""arp""ipv6_dhcp""ipv6_nd"
modelstring

ICX switch model type (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"
vlanDemandboolean

Flag indicating whether VLAN demand is required (default: false).

trustPortsArray of strings

List of port identifiers configured as trusted ports for QoS priority marking.

slotsArray of objects(FamilyModelSlotBo)unique

Set of slot configurations for modular switches with expansion slots.

{
  "id": "string",
  "tenantId": "string",
  "trustedPortType": "all",
  "model": "ICX7150-24",
  "vlanDemand": true,
  "trustPorts": [
    "string"
  ],
  "slots": [
    { … }
  ]
}

Responses

OK

Body
idstring

The identifier

trustedPortTypestring

The type of trusted port configuration: DHCP snooping or ARP inspection.

Enum"all""dhcp""arp""ipv6_dhcp""ipv6_nd"
modelstring

The switch model to which this trusted port configuration applies.

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

The flag indicating whether trusted port configuration requires VLAN specification.

trustPortsArray of strings

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

slotsArray of objects(FamilyModelSlot)unique

The set of switch family model and slot configurations for trusted port assignment across different hardware types.

Response
{
  "id": "string",
  "trustedPortType": "all",
  "model": "ICX7150-24",
  "vlanDemand": true,
  "trustPorts": [
    "string"
  ],
  "slots": [
    { … }
  ]
}

Delete Trusted PortDeprecated

Request

Delete the specified trusted port of the switch profile. This method will be removed no sooner than 08/31/2026.

Security
jwtAuth
Path
switchProfileIdstringrequired
trustedPortIdstringrequired
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"
  }
}

Add Trusted PortDeprecated

Request

Add the trusted port of the switch profile. This method will be removed no sooner than 08/31/2026.

Security
jwtAuth
Path
switchProfileIdstringrequired
Body
required
idstring

Unique identifier for the trusted port configuration.

tenantIdstring

The unique identifier of the tenant.

trustedPortTypestring

Trusted port type indicating what traffic priority marking to trust (DOT1P for 802.1p, DSCP for IP DSCP).

Enum"all""dhcp""arp""ipv6_dhcp""ipv6_nd"
modelstring

ICX switch model type (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"
vlanDemandboolean

Flag indicating whether VLAN demand is required (default: false).

trustPortsArray of strings

List of port identifiers configured as trusted ports for QoS priority marking.

slotsArray of objects(FamilyModelSlotBo)unique

Set of slot configurations for modular switches with expansion slots.

{
  "id": "string",
  "tenantId": "string",
  "trustedPortType": "all",
  "model": "ICX7150-24",
  "vlanDemand": true,
  "trustPorts": [
    "string"
  ],
  "slots": [
    { … }
  ]
}

Responses

OK

Body
idstring

The identifier

trustedPortTypestring

The type of trusted port configuration: DHCP snooping or ARP inspection.

Enum"all""dhcp""arp""ipv6_dhcp""ipv6_nd"
modelstring

The switch model to which this trusted port configuration applies.

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

The flag indicating whether trusted port configuration requires VLAN specification.

trustPortsArray of strings

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

slotsArray of objects(FamilyModelSlot)unique

The set of switch family model and slot configurations for trusted port assignment across different hardware types.

Response
{
  "id": "string",
  "trustedPortType": "all",
  "model": "ICX7150-24",
  "vlanDemand": true,
  "trustPorts": [
    "string"
  ],
  "slots": [
    { … }
  ]
}

Delete Trusted PortsDeprecated

Request

Delete multiple trusted ports of the specified switch profile. This method will be removed no sooner than 08/31/2026.

Security
jwtAuth
Path
switchProfileIdstringrequired
Bodyapplication/jsonrequiredArray [
string
]
application/json
[
  "string"
]

Responses

OK

Bodyapplication/json
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(BaseViewObject)

The response data containing the result of the operation.

Response
application/json
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Get Trusted PortsDeprecated

Request

Retrieve trusted ports with the specified venue. This method will be removed no sooner than 08/31/2026.

Security
jwtAuth
Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring

The identifier

trustedPortTypestring

The type of trusted port configuration: DHCP snooping or ARP inspection.

Enum"all""dhcp""arp""ipv6_dhcp""ipv6_nd"
modelstring

The switch model to which this trusted port configuration applies.

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

The flag indicating whether trusted port configuration requires VLAN specification.

trustPortsArray of strings

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

slotsArray of objects(FamilyModelSlot)unique

The set of switch family model and slot configurations for trusted port assignment across different hardware types.

Response
{
  "id": "string",
  "trustedPortType": "all",
  "model": "ICX7150-24",
  "vlanDemand": true,
  "trustPorts": [
    "string"
  ],
  "slots": [
    { … }
  ]
}

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