Skip to content
/
Delete Device

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

Add Device

Request

Add a new device.

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

The name of the device.

descriptionstring

The description of the device.

serialNumberstringrequired

The serial number of the device.

{
  "name": "string",
  "description": "string",
  "serialNumber": "string"
}

Responses

Created

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

Get Device

Request

Get device by the serial number.

Path
venueIdstringrequired
clusterIdstringrequired
serialNumberstringrequired
No request payload

Responses

OK

Body
namestring[ 1 .. 64 ] charactersrequired

The name of the device.

descriptionstring

The description of the device.

Response
{
  "name": "string",
  "description": "string"
}

Delete Device

Request

Delete the device by the serial number.

Path
venueIdstringrequired
clusterIdstringrequired
serialNumberstringrequired
No request payload

Responses

OK

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

Update Device

Request

Patch the device configuration.

Path
venueIdstringrequired
clusterIdstringrequired
serialNumberstringrequired
Body
required
namestring[ 1 .. 64 ] charactersrequired

The name of the device.

descriptionstring

The description of the device.

otpStatestring
Value"RENEW"
{
  "name": "string",
  "description": "string",
  "otpState": "RENEW"
}

Responses

OK

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

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