Skip to content
/
Get DHCP

RUCKUS Edge (1.0.4)

Overview

Rate Limit

For the Edge REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
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 DHCP

Edge DHCP APIs.

Operations

Get DHCP

Request

Path
dhcpIdstringrequired
No request payload

Responses

OK

Body
dhcpRelayboolean
externalDhcpServerFqdnIpstring
domainNamestring[ 0 .. 31 ] characters
primaryDnsIpstring
secondaryDnsIpstring
dhcpPoolsArray of objects(DhcpPool)
dhcpOptionsArray of objects(DhcpOptions)
hostsArray of objects(Host)
idstring
serviceNamestring[ 1 .. 64 ] characters
leaseTimeinteger(int32)
leaseTimeUnitstring
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

Path
dhcpIdstringrequired
Body
required
dhcpRelayboolean
externalDhcpServerFqdnIpstring
domainNamestring[ 0 .. 31 ] characters
primaryDnsIpstring
secondaryDnsIpstring
dhcpPoolsArray of objects(DhcpPool)
dhcpOptionsArray of objects(DhcpOptions)
hostsArray of objects(Host)
serviceNamestring[ 1 .. 64 ] characters
leaseTimeinteger(int32)
leaseTimeUnitstring
Enum"MINUTES""HOURS""DAYS"
actionstring
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
responseany
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Delete DHCP

Request

Path
dhcpIdstringrequired
No request payload

Responses

OK

Body
object
Response
{}

Patch DHCP

Request

Path
dhcpIdstringrequired
Body
required
dhcpRelayboolean
externalDhcpServerFqdnIpstring
domainNamestring[ 0 .. 31 ] characters
primaryDnsIpstring
secondaryDnsIpstring
dhcpPoolsArray of objects(DhcpPool)
dhcpOptionsArray of objects(DhcpOptions)
hostsArray of objects(Host)
serviceNamestring[ 1 .. 64 ] characters
leaseTimeinteger(int32)
leaseTimeUnitstring
Enum"MINUTES""HOURS""DAYS"
actionstring
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
responseany
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Activate DHCP

Request

Path
dhcpIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

Body
requestIdstring
responseany
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Deactivate DHCP

Request

Path
dhcpIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

Body
requestIdstring
responseany
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Create DHCP

Request

Body
required
dhcpRelayboolean
externalDhcpServerFqdnIpstring
domainNamestring[ 0 .. 31 ] characters
primaryDnsIpstring
secondaryDnsIpstring
dhcpPoolsArray of objects(DhcpPool)
dhcpOptionsArray of objects(DhcpOptions)
hostsArray of objects(Host)
idstring
serviceNamestring[ 1 .. 64 ] characters
leaseTimeinteger(int32)
leaseTimeUnitstring
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
responseany
linksArray of objects(Link)
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
{
  "filters": {
    "serviceIds": [ … ]
  }
}

Responses

OK

Body
compatibilitiesArray of objects(ServiceIncompatibleInfo)
Response
{
  "compatibilities": [
    { … }
  ]
}

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 LAG Configuration

Manage the Link Aggregation Group for Edge devices.

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 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

Manage Edge devices.

Operations