Skip to content
RUCKUS Edge/
/
Update Edge Cluster

RUCKUS Edge (1.0.4)

Overview

The Edge REST API provides comprehensive capabilities for managing edge devices, edge clusters, and network services in the RUCKUS Cloud platform. This API enables you to configure edge device settings, manage cluster configurations with high availability, control network services.

The API is designed for organizations that need to manage edge devices, configure cluster settings, control network services such as DHCP, establish tunnel profiles, and manage advanced networking features for distributed edge deployments.

What This API Does

  • Edge Device Management: Create, retrieve, update, and delete edge devices with configuration settings including device registration and basic metadata management
  • Edge Cluster Configuration: Manage edge cluster settings including high availability configurations and network settings
  • Network Interface Configuration: Configure edge ports, link aggregation groups (LAG), subinterfaces, static routes, and DNS servers for edge devices
  • DHCP Services: Manage the DHCP services for edge clusters
  • Tunnel Profile Configuration: Activate and deactivate tunnel profiles on edge clusters
  • mDNS Proxy: Configure mDNS proxy profiles for edge clusters
  • ARP Termination: Configure ARP termination settings for edge clusters
  • Edge Compatibility: Query edge device feature requirements and compatibility information
  • Troubleshooting: Trigger edge troubleshooting actions
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

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(ClusterResponseDto)

The content of the current page.

pagingobject(Paging)

Paging information.

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(ClusterMemberDto)

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

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

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(ClusterMemberDto)

A list of Edge devices in the cluster.

virtualIpSettingsobject(VirtualIpSettingsDto)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

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

Update Edge Cluster

Request

Update edge cluster configuration.

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(ClusterMemberDto)

A list of Edge devices to be in the cluster.

virtualIpSettingsobject(VirtualIpSettingsDto)Deprecated

The virtual IP settings of the cluster.

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

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

Get Edge Cluster Network

Request

Get Edge cluster network settings.

Path
venueIdstringrequired
clusterIdstringrequired
No request payload

Responses

OK

Body
virtualIpSettingsArray of objects(VirtualIpDto)

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

portSettingsArray of objects(ClusterNetworkPortSettingsDto)

List of cluster edges port settings.

lagSettingsArray of objects(ClusterNetworkLagSettingsDto)

List of cluster edges LAG settings.

highAvailabilitySettingsobject(HighAvailabilitySettingsDto)

High availability settings for active-active clusters.

subInterfaceSettingsArray of objects(NodeSubInterfaceResponseDto)

List of cluster subinterface settings.

multiWanSettingsobject(ClusterNetworkMultiWanSettingsDto)

Multi WAN settings for 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(VirtualIpDto)[ 0 .. 2 ] items

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

portSettingsArray of objects(ClusterNetworkPortSettingsDto)[ 0 .. 4 ] items

List of cluster edges port settings.

lagSettingsArray of objects(ClusterNetworkLagSettingsDto)[ 1 .. 4 ] items

List of cluster edges LAG settings.

highAvailabilitySettingsobject(HighAvailabilitySettingsDto)

High availability settings for active-active clusters.

subInterfaceSettingsArray of objects(NodeSubInterfaceDto)

List of cluster subinterface settings.

multiWanSettingsobject(ClusterNetworkMultiWanSettingsDto)

Multi WAN settings for the Edge cluster.

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

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

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