Skip to content
RUCKUS Edge/
/
Delete Link Aggregation G...

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

Edge LAG Configuration

Manage the link aggregation group for Edge devices.

Operations

Get Link Aggregation Group

Request

Get the link aggregation group by unique identifier.

Path
venueIdstringrequired
edgeClusterIdstringrequired
serialNumberstringrequired
lagIdinteger(int32)required
No request payload

Responses

OK

Body
idinteger(int32)[ 0 .. 3 ]required

The ID of the LAG, support from 0 to 3.

descriptionstring[ 0 .. 63 ] characters

The description of the LAG.

lagTypestringread-only

The type of the LAG only support the link aggregation control protocol.

Default "LACP"
Enum"STATIC""LACP"
lacpModestringrequired

LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

Enum"ACTIVE""PASSIVE"
lacpTimeoutstringrequired

LACP timeout interval (SHORT or LONG) for link failure detection.

Enum"SHORT""LONG"
lagMembersArray of objects(LagMemberDto)

List of port members in the LAG.

portTypestringrequired

The port type of the LAG.

Enum"WAN""LAN""CLUSTER""UNCONFIGURED"
ipModestring

The ip mode of the LAG.

Default "DHCP"
Enum"DHCP""STATIC"
ipstring

The IP address to be assigned to the port.

subnetstring

The IP subnet mask to be assigned to the port.

gatewaystring

The gateway address of the port.

corePortEnabledboolean

Whether to mark this port as a core port.

Default false
accessPortEnabledboolean

Whether to mark this port as a access port.

Default false
natEnabledboolean

Whether to enable the network address translation on the wan port.

Default false
natPoolsArray of objects(NatPoolDto)[ 0 .. 1 ] items

List of NAT pools associated with the LAG.

lagEnabledbooleanrequired

Whether to enable the LAG.

reportIpstringread-only

IP reported by edge device.

reportSubnetstringread-only

Subnet mask reported by edge device.

Response
{
  "id": 3,
  "description": "string",
  "lagType": "STATIC",
  "lacpMode": "ACTIVE",
  "lacpTimeout": "SHORT",
  "lagMembers": [
    { … }
  ],
  "portType": "WAN",
  "ipMode": "DHCP",
  "ip": "string",
  "subnet": "string",
  "gateway": "string",
  "corePortEnabled": false,
  "accessPortEnabled": false,
  "natEnabled": false,
  "natPools": [
    { … }
  ],
  "lagEnabled": true,
  "reportIp": "string",
  "reportSubnet": "string"
}

Update Link Aggregation Group

Request

Updates the link aggregation group by unique identifier.

Path
venueIdstringrequired
edgeClusterIdstringrequired
serialNumberstringrequired
lagIdinteger(int32)required
Body
required
descriptionstring[ 0 .. 63 ] characters

The description of the LAG.

lacpModestringrequired

LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

Enum"ACTIVE""PASSIVE"
lacpTimeoutstringrequired

LACP timeout interval (SHORT or LONG) for link failure detection.

Enum"SHORT""LONG"
lagMembersArray of objects(LagMemberDto)

List of port members in the LAG.

portTypestringrequired

The port type of the LAG.

Enum"WAN""LAN""CLUSTER""UNCONFIGURED"
ipModestring

The ip mode of the LAG.

Default "DHCP"
Enum"DHCP""STATIC"
ipstring

The IP address to be assigned to the port.

subnetstring

The IP subnet mask to be assigned to the port.

gatewaystring

The gateway address of the port.

corePortEnabledboolean

Whether to mark this port as a core port.

Default false
accessPortEnabledboolean

Whether to mark this port as a access port.

Default false
natEnabledboolean

Whether to enable the network address translation on the wan port.

Default false
natPoolsArray of objects(NatPoolDto)[ 0 .. 1 ] items

List of NAT pools associated with the LAG.

lagEnabledbooleanrequired

Whether to enable the LAG.

{
  "description": "string",
  "lacpMode": "ACTIVE",
  "lacpTimeout": "SHORT",
  "lagMembers": [
    { … }
  ],
  "portType": "WAN",
  "ipMode": "DHCP",
  "ip": "string",
  "subnet": "string",
  "gateway": "string",
  "corePortEnabled": false,
  "accessPortEnabled": false,
  "natEnabled": false,
  "natPools": [
    { … }
  ],
  "lagEnabled": true
}

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 Link Aggregation Group

Request

Delete the link aggregation group by unique identifier.

Path
venueIdstringrequired
edgeClusterIdstringrequired
serialNumberstringrequired
lagIdinteger(int32)required
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": [
    { … }
  ]
}

Partial Update Link Aggregation Group

Request

Partial update of the link aggregation group by unique identifier.

Path
venueIdstringrequired
edgeClusterIdstringrequired
serialNumberstringrequired
lagIdinteger(int32)required
Body
required
descriptionstring[ 0 .. 63 ] characters

The description of the LAG.

lacpModestringrequired

LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

Enum"ACTIVE""PASSIVE"
lacpTimeoutstringrequired

LACP timeout interval (SHORT or LONG) for link failure detection.

Enum"SHORT""LONG"
lagMembersArray of objects(LagMemberDto)

List of port members in the LAG.

portTypestringrequired

The port type of the LAG.

Enum"WAN""LAN""CLUSTER""UNCONFIGURED"
ipModestring

The ip mode of the LAG.

Default "DHCP"
Enum"DHCP""STATIC"
ipstring

The IP address to be assigned to the port.

subnetstring

The IP subnet mask to be assigned to the port.

gatewaystring

The gateway address of the port.

corePortEnabledboolean

Whether to mark this port as a core port.

Default false
accessPortEnabledboolean

Whether to mark this port as a access port.

Default false
natEnabledboolean

Whether to enable the network address translation on the wan port.

Default false
natPoolsArray of objects(NatPoolDto)[ 0 .. 1 ] items

List of NAT pools associated with the LAG.

lagEnabledbooleanrequired

Whether to enable the LAG.

{
  "description": "string",
  "lacpMode": "ACTIVE",
  "lacpTimeout": "SHORT",
  "lagMembers": [
    { … }
  ],
  "portType": "WAN",
  "ipMode": "DHCP",
  "ip": "string",
  "subnet": "string",
  "gateway": "string",
  "corePortEnabled": false,
  "accessPortEnabled": false,
  "natEnabled": false,
  "natPools": [
    { … }
  ],
  "lagEnabled": true
}

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

Create Link Aggregation Group

Request

Create the link aggregation groups.

Path
venueIdstringrequired
edgeClusterIdstringrequired
serialNumberstringrequired
Body
required
idinteger(int32)[ 0 .. 3 ]required

The ID of the LAG, support from 0 to 3.

descriptionstring[ 0 .. 63 ] characters

The description of the LAG.

lacpModestringrequired

LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

Enum"ACTIVE""PASSIVE"
lacpTimeoutstringrequired

LACP timeout interval (SHORT or LONG) for link failure detection.

Enum"SHORT""LONG"
lagMembersArray of objects(LagMemberDto)

List of port members in the LAG.

portTypestringrequired

The port type of the LAG.

Enum"WAN""LAN""CLUSTER""UNCONFIGURED"
ipModestring

The ip mode of the LAG.

Default "DHCP"
Enum"DHCP""STATIC"
ipstring

The IP address to be assigned to the port.

subnetstring

The IP subnet mask to be assigned to the port.

gatewaystring

The gateway address of the port.

corePortEnabledboolean

Whether to mark this port as a core port.

Default false
accessPortEnabledboolean

Whether to mark this port as a access port.

Default false
natEnabledboolean

Whether to enable the network address translation on the wan port.

Default false
natPoolsArray of objects(NatPoolDto)[ 0 .. 1 ] items

List of NAT pools associated with the LAG.

lagEnabledbooleanrequired

Whether to enable the LAG.

{
  "id": 3,
  "description": "string",
  "lacpMode": "ACTIVE",
  "lacpTimeout": "SHORT",
  "lagMembers": [
    { … }
  ],
  "portType": "WAN",
  "ipMode": "DHCP",
  "ip": "string",
  "subnet": "string",
  "gateway": "string",
  "corePortEnabled": false,
  "accessPortEnabled": false,
  "natEnabled": false,
  "natPools": [
    { … }
  ],
  "lagEnabled": true
}

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