Skip to content

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

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

Query Venue Edge Compatibility Information

Request

Query the compatibility info of Edge by venues or devices.

Body
required
featureNamesArray of strings

The list of feature names to be queried.

filtersobject(VenueEdgeCompatibilityFilter)required

The filters for querying the venues of the compatibility.

filters.​venueIdsArray of strings
filters.​edgeIdsArray of strings
{
  "featureNames": [
    "string"
  ],
  "filters": {
    "venueIds": [ … ],
    "edgeIds": [ … ]
  }
}

Responses

OK

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

Query Edge Features Requirement Information

Request

Query features' requirement info related to Edge.

Body
required
filtersobject(FeatureSetsFilter)

The filters of the FeatureSets.

{
  "filters": {
    "featureNames": [ … ]
  }
}

Responses

OK

Body
featureSetsArray of objects(FeatureRequirement)

A list of Edge feature requirement.

Response
{
  "featureSets": [
    { … }
  ]
}

Edge Device Management

Manage Edge devices.

Operations