Skip to content
/
Query the Edge Compatibil...

RUCKUS Edge API & Model Documentation (1.0.3)

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
Asian region
https://api.asia.ruckus.cloud/
European region
https://api.eu.ruckus.cloud/
North American region
https://api.ruckus.cloud/

Edge Static Route Configuration

Manage the static routes for a Edge

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 ] charactersrequired
leaseTimeinteger(int32)required
leaseTimeUnitstringrequired
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 ] charactersrequired
leaseTimeinteger(int32)required
leaseTimeUnitstringrequired
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
responseobject
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": {},
  "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
object
Response
{}

Activate DHCP

Request

Path
dhcpIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

Body
object
Response
{}

Deactivate DHCP

Request

Path
dhcpIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

Body
object
Response
{}

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 ] charactersrequired
leaseTimeinteger(int32)required
leaseTimeUnitstringrequired
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
responseobject
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": {},
  "links": [
    { … }
  ]
}

Query the Edge Compatibility of DHCP Services

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(ServiceIncompatibleInfoDto)
Response
{
  "compatibilities": [
    { … }
  ]
}

Edge LAG Configuration

Manage the Link Aggregation Group for Edge devices

Operations

Edge Device Management

Manage Edge devices

Operations

ARP Termination Settings

Configure ARP termination settings for a cluster

Operations

Edge DNS Configuration

Manage the DNS server for a Edge

Operations

Edge Sub-Interface Configuration

Manage the sub-interface of a physical port

Operations

Edge LAG Sub-Interface

Manage the sub-interface of a LAG

Operations

Edge Cluster Configuration

Manage the Edge cluster

Operations

Edge Port Configuration

Manage the port of a Edge

Operations

Edge Troubleshooting

Manage troubleshooting operations for the devices

Operations

Edge Compatibility Checking

Check the compatibility of Edge devices.

Operations

Edge Multicast DNS Profile

Manage the Multicast DNS Profile for Edge devices

Operations

Tunnel Profile Configuration

Manage the tunnel profile

Operations