Skip to content

RUCKUS Edge API & Model Documentation (1.0.4)

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
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 SD-LAN Service

Manage the SD-LAN services for Edge devices.

Operations

Edge Personal Identity Network Service

Manage the Personal Identity Network services for Edge devices.

Operations

Tunnel Profile Template Configuration

Manage the tunnel profile template.

Operations

Edge SD-LAN Service Delegation

Manage the delegated SD-LAN services for Edge devices.

Operations

Activate Customer in SD-LAN Service

Request

Activate a customer tenant in SD-LAN service.

Path
sdLanServiceIdstringrequired
ecTenantIdstringrequired
No request payload

Responses

Accepted

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

Deactivate Customer in SD-LAN Service

Request

Deactivate a customer tenant in SD-LAN service.

Path
sdLanServiceIdstringrequired
ecTenantIdstringrequired
No request payload

Responses

Accepted

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

Activate a Network Template in SD-LAN for a Specific Venue Template

Request

Activate a network template in SD-LAN service for a specific venue template.

Path
sdLanServiceIdstringrequired
venueTemplateIdstringrequired
wifiNetworkTemplateIdstringrequired
Body
required
forwardingTunnelProfileIdstring

The ID of the tunnel profile used for forwarding traffic from the Edge cluster.

{
  "forwardingTunnelProfileId": "string"
}

Responses

Accepted

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

Deactivate a Network Template in SD-LAN for a Specific Venue of the Template

Request

Deactivate a network template in SD-LAN service for a specific venue of the template.

Path
sdLanServiceIdstringrequired
venueTemplateIdstringrequired
wifiNetworkTemplateIdstringrequired
No request payload

Responses

Accepted

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