Skip to content
Switch Services/
/
Delete DHCP Servers

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

Update DHCP Server SettingDeprecated

Request

Update switch's DHCP server setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId} can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
Body
required
idstring

Unique identifier for the DHCP server configuration.

poolNamestring

Name of the DHCP address pool (must be unique).

networkstring

Network address in CIDR notation (e.g., 192.168.1.0/24).

defaultRouterIpstring

Default gateway IP address to be assigned to DHCP clients.

excludedEndstring

End IP address of the excluded range (addresses not to be assigned).

excludedStartstring

Start IP address of the excluded range (addresses not to be assigned).

leaseDaysinteger(int32)

Lease duration in days.

leaseHrsinteger(int32)

Lease duration in hours.

leaseMinsinteger(int32)

Lease duration in minutes.

dhcpOptionsArray of objects(DhcpOptionBo)

List of additional DHCP options (e.g., DNS server, domain name).

subnetAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...

Subnet address extracted from the network configuration.

subnetMaskstring^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...

Subnet mask for the DHCP pool network (e.g., 255.255.255.0).

switchIdstring

Switch identifier (serial number) where this DHCP server is configured.

prefixLengthstring

Network prefix length (CIDR notation, e.g., 24 for /24).

dhcpServerEnabledboolean

Flag indicating whether the DHCP server is enabled on the switch.

{
  "id": "string",
  "poolName": "string",
  "network": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string",
  "switchId": "string",
  "prefixLength": "string",
  "dhcpServerEnabled": true
}

Responses

OK

Body
idstring

The unique identifier of the DHCP server configuration.

poolNamestring

The name of the DHCP address pool.

networkstring

The network address for the DHCP pool.

defaultRouterIpstring

The default gateway IP address provided to DHCP clients.

excludedEndstring

The ending IP address of the excluded address range that will not be assigned to clients.

excludedStartstring

The starting IP address of the excluded address range that will not be assigned to clients.

leaseDaysinteger(int32)

The number of days in the DHCP lease duration.

leaseHrsinteger(int32)

The number of hours in the DHCP lease duration.

leaseMinsinteger(int32)

The number of minutes in the DHCP lease duration.

dhcpOptionsArray of objects(DhcpOption)

The list of additional DHCP options to be provided to clients.

subnetAddressstring

The subnet network address for the DHCP pool.

subnetMaskstring

The subnet mask for the DHCP network.

Response
{
  "id": "string",
  "poolName": "string",
  "network": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string"
}

Add DHCP ServerDeprecated

Request

Add switch's DHCP server settings. 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}/dhcpServers can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
Body
required
idstring

Unique identifier for the DHCP server configuration.

poolNamestring

Name of the DHCP address pool (must be unique).

networkstring

Network address in CIDR notation (e.g., 192.168.1.0/24).

defaultRouterIpstring

Default gateway IP address to be assigned to DHCP clients.

excludedEndstring

End IP address of the excluded range (addresses not to be assigned).

excludedStartstring

Start IP address of the excluded range (addresses not to be assigned).

leaseDaysinteger(int32)

Lease duration in days.

leaseHrsinteger(int32)

Lease duration in hours.

leaseMinsinteger(int32)

Lease duration in minutes.

dhcpOptionsArray of objects(DhcpOptionBo)

List of additional DHCP options (e.g., DNS server, domain name).

subnetAddressstring^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...

Subnet address extracted from the network configuration.

subnetMaskstring^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...

Subnet mask for the DHCP pool network (e.g., 255.255.255.0).

switchIdstring

Switch identifier (serial number) where this DHCP server is configured.

prefixLengthstring

Network prefix length (CIDR notation, e.g., 24 for /24).

dhcpServerEnabledboolean

Flag indicating whether the DHCP server is enabled on the switch.

{
  "id": "string",
  "poolName": "string",
  "network": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string",
  "switchId": "string",
  "prefixLength": "string",
  "dhcpServerEnabled": true
}

Responses

OK

Body
idstring

The unique identifier of the DHCP server configuration.

poolNamestring

The name of the DHCP address pool.

networkstring

The network address for the DHCP pool.

defaultRouterIpstring

The default gateway IP address provided to DHCP clients.

excludedEndstring

The ending IP address of the excluded address range that will not be assigned to clients.

excludedStartstring

The starting IP address of the excluded address range that will not be assigned to clients.

leaseDaysinteger(int32)

The number of days in the DHCP lease duration.

leaseHrsinteger(int32)

The number of hours in the DHCP lease duration.

leaseMinsinteger(int32)

The number of minutes in the DHCP lease duration.

dhcpOptionsArray of objects(DhcpOption)

The list of additional DHCP options to be provided to clients.

subnetAddressstring

The subnet network address for the DHCP pool.

subnetMaskstring

The subnet mask for the DHCP network.

Response
{
  "id": "string",
  "poolName": "string",
  "network": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string"
}

Delete DHCP ServersDeprecated

Request

Delete switch's DHCP servers. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers can be used for this content.

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

Query DHCP ServersDeprecated

Request

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

Security
jwtAuth
Path
switchIdstringrequired
Body
required
fieldsArray of strings

The list of field names to include in the query response, allowing clients to request only specific fields.

pageinteger(int32)

The page number for pagination, starting from 1, defaulting to 1.

pageSizeinteger(int32)

The number of records to return per page, defaulting to 25.

sortFieldstring

The field name to use for sorting the query results.

sortOrderstring

The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Enum"ASC""DESC"
venueIdstring

The venue identifier to filter DHCP server configurations by specific venue.

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "venueId": "string"
}

Responses

OK

Body
idstring
dataArray of objects

The list of data records returned by the query, with each item representing a result object.

fieldsArray of strings

The list of field names included in the query response data.

pageinteger(int32)

The current page number of the paginated results.

totalCountinteger(int64)

The total number of records matching the query criteria across all pages.

totalPagesinteger(int32)

The total number of pages available based on the page size and total record count.

Response
{
  "id": "string",
  "data": [
    null
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Update DHCP ServerDeprecated

Request

Change switch's DHCP server state. 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}/dhcpServerStates with PATCH method can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
Body
required
stateboolean

DHCP server state (true to enable, false to disable).

{
  "state": true
}

Responses

OK

Body
idstring

The unique identifier of the DHCP server configuration.

poolNamestring

The name of the DHCP address pool.

networkstring

The network address for the DHCP pool.

defaultRouterIpstring

The default gateway IP address provided to DHCP clients.

excludedEndstring

The ending IP address of the excluded address range that will not be assigned to clients.

excludedStartstring

The starting IP address of the excluded address range that will not be assigned to clients.

leaseDaysinteger(int32)

The number of days in the DHCP lease duration.

leaseHrsinteger(int32)

The number of hours in the DHCP lease duration.

leaseMinsinteger(int32)

The number of minutes in the DHCP lease duration.

dhcpOptionsArray of objects(DhcpOption)

The list of additional DHCP options to be provided to clients.

subnetAddressstring

The subnet network address for the DHCP pool.

subnetMaskstring

The subnet mask for the DHCP network.

Response
{
  "id": "string",
  "poolName": "string",
  "network": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string"
}

Query DHCP ServersDeprecated

Request

List of venue's DHCP servers. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/query can be used for this content.

Security
jwtAuth
Body
required
fieldsArray of strings

The list of field names to include in the query response, allowing clients to request only specific fields.

pageinteger(int32)

The page number for pagination, starting from 1, defaulting to 1.

pageSizeinteger(int32)

The number of records to return per page, defaulting to 25.

sortFieldstring

The field name to use for sorting the query results.

sortOrderstring

The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Enum"ASC""DESC"
venueIdstring

The venue identifier to filter DHCP server configurations by specific venue.

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "venueId": "string"
}

Responses

OK

Body
idstring
dataArray of objects

The list of data records returned by the query, with each item representing a result object.

fieldsArray of strings

The list of field names included in the query response data.

pageinteger(int32)

The current page number of the paginated results.

totalCountinteger(int64)

The total number of records matching the query criteria across all pages.

totalPagesinteger(int32)

The total number of pages available based on the page size and total record count.

Response
{
  "id": "string",
  "data": [
    null
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Get DHCP Server SettingDeprecated

Request

Get switch's DHCP server setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId} can be used for this content.

Security
jwtAuth
Path
dhcpServerIdstringrequired
No request payload

Responses

OK

Body
idstring

The unique identifier of the DHCP server configuration.

poolNamestring

The name of the DHCP address pool.

networkstring

The network address for the DHCP pool.

defaultRouterIpstring

The default gateway IP address provided to DHCP clients.

excludedEndstring

The ending IP address of the excluded address range that will not be assigned to clients.

excludedStartstring

The starting IP address of the excluded address range that will not be assigned to clients.

leaseDaysinteger(int32)

The number of days in the DHCP lease duration.

leaseHrsinteger(int32)

The number of hours in the DHCP lease duration.

leaseMinsinteger(int32)

The number of minutes in the DHCP lease duration.

dhcpOptionsArray of objects(DhcpOption)

The list of additional DHCP options to be provided to clients.

subnetAddressstring

The subnet network address for the DHCP pool.

subnetMaskstring

The subnet mask for the DHCP network.

Response
{
  "id": "string",
  "poolName": "string",
  "network": "string",
  "defaultRouterIp": "string",
  "excludedEnd": "string",
  "excludedStart": "string",
  "leaseDays": 0,
  "leaseHrs": 0,
  "leaseMins": 0,
  "dhcpOptions": [
    { … }
  ],
  "subnetAddress": "string",
  "subnetMask": "string"
}

Delete DHCP Server SettingDeprecated

Request

Delete switch's DHCP server setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId} can be used for this content.

Security
jwtAuth
Path
switchIdstringrequired
dhcpServerIdstringrequired
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"
  }
}

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

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