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

Get Edge Clusters

Request

Get a list of Edge clusters.

Path
venueIdstringrequired
Query
pageinteger(int32)>= 1

Page index

Default 1
pageSizeinteger(int32)

The size of the page to be returned

Default 20
No request payload

Responses

OK

Body
contentArray of objects(Edge Cluster Information)
pagingobject(Paging)
Response
{
  "content": [
    { … }
  ],
  "paging": {
    "page": 0,
    "pageSize": 0,
    "totalCount": 0
  }
}

Create Edge Cluster

Request

Create a Edge cluster.

Path
venueIdstringrequired
Body
required
namestring[ 1 .. 64 ] characters

The name of the cluster.

descriptionstring[ 0 .. 255 ] characters

The description of the cluster.

smartEdgesArray of objects(Edge Cluster Member Configuration)

A list of Edge devices to be in the cluster.

highAvailabilityModestring

The high availability mode.

Enum"ACTIVE_STANDBY""ACTIVE_ACTIVE"
{
  "name": "string",
  "description": "string",
  "smartEdges": [
    { … }
  ],
  "highAvailabilityMode": "ACTIVE_STANDBY"
}

Responses

Accepted

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

Get Edge Cluster

Request

Get the Edge cluster by unique identifier.

Path
venueIdstringrequired
clusterIdstringrequired
No request payload

Responses

OK

Body
idstring

The ID of the cluster.

namestring

The name of the cluster.

descriptionstring

The description of the cluster.

highAvailabilityModestring

The high availability mode.

Enum"ACTIVE_STANDBY""ACTIVE_ACTIVE"
smartEdgesArray of objects(Edge Cluster Member Configuration)

A list of Edge devices in the cluster.

virtualIpSettingsobject(Cluster Virtual IP Configuration)Deprecated

The virtual IP settings of the cluster.

Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "highAvailabilityMode": "ACTIVE_STANDBY",
  "smartEdges": [
    { … }
  ],
  "virtualIpSettings": {
    "virtualIps": [ … ]
  }
}

Delete a Edge Cluster

Request

Delete a Edge cluster.

Path
venueIdstringrequired
clusterIdstringrequired
No request payload

Responses

Accepted

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

Update Edge Cluster

Request

Update Edge cluster.

Path
venueIdstringrequired
clusterIdstringrequired
Body
required
namestring[ 1 .. 64 ] characters

The name of the cluster.

descriptionstring[ 0 .. 255 ] characters

The description of the cluster.

smartEdgesArray of objects(Edge Cluster Member Configuration)

A list of Edge devices to be in the cluster.

virtualIpSettingsobject(Cluster Virtual IP Configuration)Deprecated

The virtual IP settings of the cluster.

{
  "name": "string",
  "description": "string",
  "smartEdges": [
    { … }
  ],
  "virtualIpSettings": {
    "virtualIps": [ … ]
  }
}

Responses

Accepted

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

Get Edge Cluster Network

Request

Get Edge cluster network settings.

Path
venueIdstringrequired
clusterIdstringrequired
No request payload

Responses

OK

Body
virtualIpSettingsArray of objects(Virtual IP Configuration)

List of cluster virtual IP settings for active-standby clusters.

portSettingsArray of objects(Edge Port Settings)

List of cluster edges port settings.

lagSettingsArray of objects(Edge Link Aggregation Group Settings)

List of cluster edges LAG settings.

highAvailabilitySettingsobject(Edge Cluster High Availability Settings)

High availability settings for active-active clusters.

subInterfaceSettingsArray of objects(NodeSubInterfaceResponseDto)

List of cluster sub-interface settings.

multiWanSettingsobject(Edge Multi WAN Settings)

The multi WAN settings of the Edge cluster.

Response
{
  "virtualIpSettings": [
    { … }
  ],
  "portSettings": [
    { … }
  ],
  "lagSettings": [
    { … }
  ],
  "highAvailabilitySettings": {
    "fallbackSettings": { … },
    "loadDistribution": "RANDOM"
  },
  "subInterfaceSettings": [
    { … }
  ],
  "multiWanSettings": {
    "mode": "NONE",
    "wanMembers": [ … ]
  }
}

Update Edge Cluster Network

Request

Update Edge cluster network settings.

Path
venueIdstringrequired
clusterIdstringrequired
Body
required
virtualIpSettingsArray of objects(Virtual IP Configuration)[ 0 .. 2 ] items

List of cluster virtual IP settings for active-standby clusters.

portSettingsArray of objects(Edge Port Settings)[ 0 .. 4 ] items
lagSettingsArray of objects(Edge Link Aggregation Group Settings)[ 1 .. 4 ] items
highAvailabilitySettingsobject(Edge Cluster High Availability Settings)

High availability settings for active-active clusters.

subInterfaceSettingsArray of objects(Edge SubInterface Settings)
multiWanSettingsobject(Edge Multi WAN Settings)

The multi WAN settings of the Edge cluster.

{
  "virtualIpSettings": [
    { … }
  ],
  "portSettings": [
    { … }
  ],
  "lagSettings": [
    { … }
  ],
  "highAvailabilitySettings": {
    "fallbackSettings": { … },
    "loadDistribution": "RANDOM"
  },
  "subInterfaceSettings": [
    { … }
  ],
  "multiWanSettings": {
    "mode": "NONE",
    "wanMembers": [ … ]
  }
}

Responses

Accepted

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

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

Tunnel Profile Configuration

Manage the tunnel profile

Operations