Skip to content

RUCKUS Edge (1.0.4)

Overview

Download OpenAPI description
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

Get Multicast DNS Profile

Request

Get multicast DNS profile.

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

Update multicast DNS profile.

Path
multicastDnsProxyProfileIdstringrequired

The ID of Multicast DNS profile.

Bodyrequired
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

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 Multicast DNS Profile

Request

Delete multicast DNS profile.

Path
multicastDnsProxyProfileIdstringrequired

The ID of Multicast DNS profile.

No request payload

Responses

Accepted

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

Request

Activate multicast DNS on edge cluster.

Path
multicastDnsProxyProfileIdstringrequired
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 Multicast DNS

Request

Deactivate multicast DNS on edge cluster.

Path
multicastDnsProxyProfileIdstringrequired
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 Multicast DNS Profile

Request

Create multicast DNS profile.

Bodyrequired
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

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": [ {} ] }

Edge Troubleshooting

Manage troubleshooting operations for the devices.

Operations

Edge DHCP

Manage the DHCP services for Edge 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

Edge device management operations.

Operations