Skip to content
RUCKUS Edge/
/
Activate DHCP

RUCKUS Edge (1.0.4)

Overview

The Edge REST API provides comprehensive capabilities for managing edge devices, edge clusters, and network services in the RUCKUS Cloud platform. This API enables you to configure edge device settings, manage cluster configurations with high availability, control network services.

The API is designed for organizations that need to manage edge devices, configure cluster settings, control network services such as DHCP, establish tunnel profiles, and manage advanced networking features for distributed edge deployments.

What This API Does

  • Edge Device Management: Create, retrieve, update, and delete edge devices with configuration settings including device registration and basic metadata management
  • Edge Cluster Configuration: Manage edge cluster settings including high availability configurations and network settings
  • Network Interface Configuration: Configure edge ports, link aggregation groups (LAG), subinterfaces, static routes, and DNS servers for edge devices
  • DHCP Services: Manage the DHCP services for edge clusters
  • Tunnel Profile Configuration: Activate and deactivate tunnel profiles on edge clusters
  • mDNS Proxy: Configure mDNS proxy profiles for edge clusters
  • ARP Termination: Configure ARP termination settings for edge clusters
  • Edge Compatibility: Query edge device feature requirements and compatibility information
  • Troubleshooting: Trigger edge troubleshooting actions
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
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

Edge DNS Configuration

Manage the DNS server for a Edge.

Operations

Edge Cluster Configuration

Manage the Edge cluster.

Operations

Edge LAG Configuration

Manage the link aggregation group for Edge devices.

Operations

Edge LAG Subinterface

Manage the subinterface of a LAG.

Operations

Tunnel Profile Configuration

Manage the tunnel profile.

Operations

Edge Subinterface Configuration

Manage the subinterface of a physical port.

Operations

Edge Static Route Configuration

Manage the static routes for a Edge.

Operations

Edge Multicast DNS Profile

Manage the Multicast DNS Profile for Edge devices.

Operations

Edge Troubleshooting

Manage troubleshooting operations for the devices.

Operations

Edge DHCP

Manage the DHCP services for Edge devices.

Operations

Get DHCP

Request

Get DHCP configuration for edge cluster.

Path
dhcpIdstringrequired
No request payload

Responses

OK

Body
dhcpRelayboolean

Whether DHCP relay is enabled.

externalDhcpServerFqdnIpstring

The external DHCP server FQDN or IP address.

domainNamestring[ 0 .. 31 ] characters

The domain name for DHCP clients.

primaryDnsIpstring

The primary DNS server IP address.

secondaryDnsIpstring

The secondary DNS server IP address.

dhcpPoolsArray of objects(DhcpPool)

List of DHCP pools.

dhcpOptionsArray of objects(DhcpOptions)

List of DHCP options.

hostsArray of objects(Host)

List of DHCP hosts with fixed IP addresses.

idstring

The identifier of the Edge DHCP profile.

serviceNamestring[ 1 .. 64 ] characters

The name of the DHCP service.

leaseTimeinteger(int32)

The lease time duration.

leaseTimeUnitstring

The unit of the lease time.

Enum"MINUTES""HOURS""DAYS"
Response
{
  "dhcpRelay": true,
  "externalDhcpServerFqdnIp": "string",
  "domainName": "string",
  "primaryDnsIp": "string",
  "secondaryDnsIp": "string",
  "dhcpPools": [
    { … }
  ],
  "dhcpOptions": [
    { … }
  ],
  "hosts": [
    { … }
  ],
  "id": "string",
  "serviceName": "string",
  "leaseTime": 0,
  "leaseTimeUnit": "MINUTES"
}

Update DHCP

Request

Update DHCP configuration for edge cluster.

Path
dhcpIdstringrequired
Body
required
dhcpRelayboolean

Whether DHCP relay is enabled.

externalDhcpServerFqdnIpstring

The external DHCP server FQDN or IP address.

domainNamestring[ 0 .. 31 ] characters

The domain name for DHCP clients.

primaryDnsIpstring

The primary DNS server IP address.

secondaryDnsIpstring

The secondary DNS server IP address.

dhcpPoolsArray of objects(DhcpPool)

List of DHCP pools.

dhcpOptionsArray of objects(DhcpOptions)

List of DHCP options.

hostsArray of objects(Host)

List of DHCP hosts with fixed IP addresses.

serviceNamestring[ 1 .. 64 ] characters

The name of the DHCP service.

leaseTimeinteger(int32)

The lease time duration.

leaseTimeUnitstring

The unit of the lease time.

Enum"MINUTES""HOURS""DAYS"
actionstring

The action to perform on the DHCP service.

Value"UPDATE_NOW"
{
  "dhcpRelay": true,
  "externalDhcpServerFqdnIp": "string",
  "domainName": "string",
  "primaryDnsIp": "string",
  "secondaryDnsIp": "string",
  "dhcpPools": [
    { … }
  ],
  "dhcpOptions": [
    { … }
  ],
  "hosts": [
    { … }
  ],
  "serviceName": "string",
  "leaseTime": 0,
  "leaseTimeUnit": "MINUTES",
  "action": "UPDATE_NOW"
}

Responses

OK

Body
requestIdstring

A unique identifier for the specific API request.

responseany

The response body containing the actual result data.

linksArray of objects(Link)

A collection of related resource links (HATEOAS) allowing clients to discover related resources.

Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Delete DHCP

Request

Delete DHCP configuration for edge cluster.

Path
dhcpIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

A unique identifier for the specific API request.

responseany

The response body containing the actual result data.

linksArray of objects(Link)

A collection of related resource links (HATEOAS) allowing clients to discover related resources.

Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Patch DHCP

Request

Partial update DHCP configuration for edge cluster.

Path
dhcpIdstringrequired
Body
required
dhcpRelayboolean

Whether DHCP relay is enabled.

externalDhcpServerFqdnIpstring

The external DHCP server FQDN or IP address.

domainNamestring[ 0 .. 31 ] characters

The domain name for DHCP clients.

primaryDnsIpstring

The primary DNS server IP address.

secondaryDnsIpstring

The secondary DNS server IP address.

dhcpPoolsArray of objects(DhcpPool)

List of DHCP pools.

dhcpOptionsArray of objects(DhcpOptions)

List of DHCP options.

hostsArray of objects(Host)

List of DHCP hosts with fixed IP addresses.

serviceNamestring[ 1 .. 64 ] characters

The name of the DHCP service.

leaseTimeinteger(int32)

The lease time duration.

leaseTimeUnitstring

The unit of the lease time.

Enum"MINUTES""HOURS""DAYS"
actionstring

The action to perform on the DHCP service.

Value"UPDATE_NOW"
{
  "dhcpRelay": true,
  "externalDhcpServerFqdnIp": "string",
  "domainName": "string",
  "primaryDnsIp": "string",
  "secondaryDnsIp": "string",
  "dhcpPools": [
    { … }
  ],
  "dhcpOptions": [
    { … }
  ],
  "hosts": [
    { … }
  ],
  "serviceName": "string",
  "leaseTime": 0,
  "leaseTimeUnit": "MINUTES",
  "action": "UPDATE_NOW"
}

Responses

OK

Body
requestIdstring

A unique identifier for the specific API request.

responseany

The response body containing the actual result data.

linksArray of objects(Link)

A collection of related resource links (HATEOAS) allowing clients to discover related resources.

Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Activate DHCP

Request

Activate DHCP service on Edge Cluster.

Path
dhcpIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

A unique identifier for the specific API request.

responseany

The response body containing the actual result data.

linksArray of objects(Link)

A collection of related resource links (HATEOAS) allowing clients to discover related resources.

Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Deactivate DHCP

Request

Deactivate DHCP service on edge cluster.

Path
dhcpIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

A unique identifier for the specific API request.

responseany

The response body containing the actual result data.

linksArray of objects(Link)

A collection of related resource links (HATEOAS) allowing clients to discover related resources.

Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Create DHCP

Request

Create DHCP configuration for edge cluster.

Body
required
dhcpRelayboolean

Whether DHCP relay is enabled.

externalDhcpServerFqdnIpstring

The external DHCP server FQDN or IP address.

domainNamestring[ 0 .. 31 ] characters

The domain name for DHCP clients.

primaryDnsIpstring

The primary DNS server IP address.

secondaryDnsIpstring

The secondary DNS server IP address.

dhcpPoolsArray of objects(DhcpPool)

List of DHCP pools.

dhcpOptionsArray of objects(DhcpOptions)

List of DHCP options.

hostsArray of objects(Host)

List of DHCP hosts with fixed IP addresses.

idstring

The identifier of the Edge DHCP profile.

serviceNamestring[ 1 .. 64 ] characters

The name of the DHCP service.

leaseTimeinteger(int32)

The lease time duration.

leaseTimeUnitstring

The unit of the lease time.

Enum"MINUTES""HOURS""DAYS"
{
  "dhcpRelay": true,
  "externalDhcpServerFqdnIp": "string",
  "domainName": "string",
  "primaryDnsIp": "string",
  "secondaryDnsIp": "string",
  "dhcpPools": [
    { … }
  ],
  "dhcpOptions": [
    { … }
  ],
  "hosts": [
    { … }
  ],
  "id": "string",
  "serviceName": "string",
  "leaseTime": 0,
  "leaseTimeUnit": "MINUTES"
}

Responses

OK

Body
requestIdstring

A unique identifier for the specific API request.

responseany

The response body containing the actual result data.

linksArray of objects(Link)

A collection of related resource links (HATEOAS) allowing clients to discover related resources.

Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Query DHCP Edge Compatibility Details

Request

Query the compatibility info of Edge by DHCP services.

Body
required
filtersobject(ServiceEdgeCompatibilityFilter)required

The filters for querying the services of the compatibility.

filters.​serviceIdsArray of strings

List of service identifiers to filter by.

{
  "filters": {
    "serviceIds": [ … ]
  }
}

Responses

OK

Body
compatibilitiesArray of objects(ServiceIncompatibleInfo)

List of compatibility information for services and Edge devices.

Response
{
  "compatibilities": [
    { … }
  ]
}

Edge Port Configuration

Manage the port of a Edge.

Operations

ARP Termination Settings

Configure ARP termination settings for a cluster.

Operations

Edge Compatibility Checking

Check the compatibility of Edge devices.

Operations

Edge Device Management

Edge device management operations.

Operations