Skip to content
/
Create Multicast DNS Prof...

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

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

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
responseany
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

Delete Multicast DNS Profile

Request

Path
multicastDnsProxyProfileIdstringrequired

The ID of Multicast DNS profile.

No request payload

Responses

Accepted

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

Activate Multicast DNS

Request

Path
multicastDnsProxyProfileIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

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

Deactivate Multicast DNS

Request

Path
multicastDnsProxyProfileIdstringrequired
venueIdstringrequired
edgeClusterIdstringrequired
No request payload

Responses

OK

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

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
responseany
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": null,
  "links": [
    { … }
  ]
}

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