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

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
Enum"ACTIVE""PASSIVE"
lacpTimeoutstringrequired
Enum"SHORT""LONG"
lagMembersArray of objects(LagMemberDto)
portTypestringrequired
Enum"WAN""LAN""CLUSTER""UNCONFIGURED"
ipModestring
Default "DHCP"
Enum"DHCP""STATIC"
ipstring

The IP address to be assigned to the port.

subnetstring

The IP sub-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

Sub-network 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
Enum"ACTIVE""PASSIVE"
lacpTimeoutstringrequired
Enum"SHORT""LONG"
lagMembersArray of objects(LagMemberDto)
portTypestringrequired
Enum"WAN""LAN""CLUSTER""UNCONFIGURED"
ipModestring
Default "DHCP"
Enum"DHCP""STATIC"
ipstring

The IP address to be assigned to the port.

subnetstring

The IP sub-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
responseobject
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": {},
  "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
responseobject
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": {},
  "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
Enum"ACTIVE""PASSIVE"
lacpTimeoutstringrequired
Enum"SHORT""LONG"
lagMembersArray of objects(LagMemberDto)
portTypestringrequired
Enum"WAN""LAN""CLUSTER""UNCONFIGURED"
ipModestring
Default "DHCP"
Enum"DHCP""STATIC"
ipstring

The IP address to be assigned to the port.

subnetstring

The IP sub-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
responseobject
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": {},
  "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
Enum"ACTIVE""PASSIVE"
lacpTimeoutstringrequired
Enum"SHORT""LONG"
lagMembersArray of objects(LagMemberDto)
portTypestringrequired
Enum"WAN""LAN""CLUSTER""UNCONFIGURED"
ipModestring
Default "DHCP"
Enum"DHCP""STATIC"
ipstring

The IP address to be assigned to the port.

subnetstring

The IP sub-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
responseobject
linksArray of objects(Link)
Response
{
  "requestId": "string",
  "response": {},
  "links": [
    { … }
  ]
}

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

Edge Multicast DNS Profile

Manage the Multicast DNS Profile for Edge devices

Operations

Tunnel Profile Configuration

Manage the tunnel profile

Operations