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

Get Sub-Interfaces

Request

Get sub-interfaces of a physical port.

Path
venueIdstringrequired
clusterIdstringrequired
serialNumberstringrequired

The SN of the Edge device

Example: 966B4AF92A7B5711EDB27B000C29D14F2E
portIdstringrequired

The ID of the physical port

Example: 3f21d371-35b6-4288-a70b-2dd6b83e7419
Query
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 20
No request payload

Responses

OK

Bodyapplication/vnd.ruckus.v1+json
pageinteger(int32)

Zero-based page index.

pageSizeinteger(int32)

The size of the page to be returned.

totalCountinteger(int64)

The total number of the data.

contentArray of objects(SubInterface configuration)

The queried data.

Response
application/vnd.ruckus.v1+json
{
  "page": 0,
  "pageSize": 0,
  "totalCount": 0,
  "content": [
    { … }
  ]
}

Create Multiple Sub-Interfaces

Request

Create multiple sub-interfaces of a physical port from CSV file.

Path
venueIdstringrequired
clusterIdstringrequired
serialNumberstringrequired

The SN of the Edge device

Example: 966B4AF92A7B5711EDB27B000C29D14F2E
portIdstringrequired

The ID of the physical port

Example: 3f21d371-35b6-4288-a70b-2dd6b83e7419
Body
required
vlaninteger(int32)required

The virtual LAN ID of the sub-interface.

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
{
  "vlan": 0,
  "portType": "WAN",
  "ipMode": "DHCP",
  "ip": "string",
  "subnet": "string",
  "gateway": "string",
  "corePortEnabled": false,
  "accessPortEnabled": false
}

Responses

Accepted

Bodyapplication/vnd.ruckus.v1+json
requestIdstring
responseobject
linksArray of objects(Link)
Response
application/vnd.ruckus.v1+json
{
  "requestId": "string",
  "response": {},
  "links": [
    { … }
  ]
}

Delete Sub-Interface

Request

Delete a sub-interfaces of a physical port.

Path
venueIdstringrequired
clusterIdstringrequired
serialNumberstringrequired

The SN of the Edge device

Example: 966B4AF92A7B5711EDB27B000C29D14F2E
portIdstringrequired

The ID of the physical port

Example: 3f21d371-35b6-4288-a70b-2dd6b83e7419
subInterfaceIdstringrequired
No request payload

Responses

Accepted

Bodyapplication/vnd.ruckus.v1+json
requestIdstring
responseobject
linksArray of objects(Link)
Response
application/vnd.ruckus.v1+json
{
  "requestId": "string",
  "response": {},
  "links": [
    { … }
  ]
}

Update Sub-Interface

Request

Update a sub-interface of a physical port.

Path
venueIdstringrequired
clusterIdstringrequired
serialNumberstringrequired

The SN of the Edge device

Example: 966B4AF92A7B5711EDB27B000C29D14F2E
portIdstringrequired

The ID of the physical port

Example: 3f21d371-35b6-4288-a70b-2dd6b83e7419
subInterfaceIdstringrequired
Bodyapplication/vnd.ruckus.v1+jsonrequired
vlaninteger(int32)required

The virtual LAN ID of the sub-interface.

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
application/vnd.ruckus.v1+json
{
  "vlan": 0,
  "portType": "WAN",
  "ipMode": "DHCP",
  "ip": "string",
  "subnet": "string",
  "gateway": "string",
  "corePortEnabled": false,
  "accessPortEnabled": false
}

Responses

Accepted

Bodyapplication/vnd.ruckus.v1+json
requestIdstring
responseobject
linksArray of objects(Link)
Response
application/vnd.ruckus.v1+json
{
  "requestId": "string",
  "response": {},
  "links": [
    { … }
  ]
}

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