Skip to content

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

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

Get Multicast DNS Profile

Request

Path
multicastDnsProxyProfileIdstringrequired

The ID of Multicast DNS profile.

No request payload

Responses

OK

Body
idstringread-only

The identifier of the multicast DNS proxy.

namestring[ 1 .. 64 ] charactersrequired

The name of the multicast DNS proxy.

forwardingRulesArray of objects(EdgeMdnsProxyProfileForwardingRule)

Up to 32 rules may be added.

Response
{
  "id": "string",
  "name": "string",
  "forwardingRules": [
    { … }
  ]
}

Update Multicast DNS Profile

Request

Path
multicastDnsProxyProfileIdstringrequired

The ID of Multicast DNS profile.

Body
required
namestring[ 1 .. 64 ] charactersrequired

The name of the multicast DNS proxy.

forwardingRulesArray of objects(EdgeMdnsProxyProfileForwardingRule)

Up to 32 rules may be added.

{
  "name": "string",
  "forwardingRules": [
    { … }
  ]
}

Responses

Accepted

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

Delete Multicast DNS Profile

Request

Path
multicastDnsProxyProfileIdstringrequired

The ID of Multicast DNS profile.

No request payload

Responses

Accepted

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

Activate Multicast DNS

Request

Path
multicastDnsProxyProfileIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

Body
object
Response
{}

Deactivate Multicast DNS

Request

Path
multicastDnsProxyProfileIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

Body
object
Response
{}

Create Multicast DNS Profile

Request

Body
required
namestring[ 1 .. 64 ] charactersrequired

The name of the multicast DNS proxy.

forwardingRulesArray of objects(EdgeMdnsProxyProfileForwardingRule)

Up to 32 rules may be added.

{
  "name": "string",
  "forwardingRules": [
    { … }
  ]
}

Responses

Accepted

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

Tunnel Profile Configuration

Manage the tunnel profile

Operations