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

Query the Edge Compatibility by Venues or Devices

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

Query the Requirement of Edge Features

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(A Feature Requirement Details of Edge)

A list of Edge feature requirement.

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

Edge Multicast DNS Profile

Manage the Multicast DNS Profile for Edge devices

Operations

Tunnel Profile Configuration

Manage the tunnel profile

Operations