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

Get SD-LAN Service

Request

Path
sdLanServiceIdstringrequired

The ID of SD-LAN Service.

No request payload

Responses

OK

Body
namestring

Name of the SD-LAN service.

applyTostring

Scope where the SD-LAN service is applied to. Supported values: MY_ACCOUNT (current account), MY_CUSTOMERS (managed customers; MSP-EC tenants only), BOTH (current account and managed customers).

Enum"BOTH""MY_ACCOUNT""MY_CUSTOMERS"
tunnelProfileIdstring

The tunnel profile identifier of the SD-LAN service.

tunnelTemplateIdstring

The tunnel template identifier of the SD-LAN service.

idstringread-only

The identifier of the SD-LAN service.

Response
{
  "name": "string",
  "applyTo": "BOTH",
  "tunnelProfileId": "string",
  "tunnelTemplateId": "string",
  "id": "string"
}

Update SD-LAN Service

Request

Path
sdLanServiceIdstringrequired

The ID of SD-LAN Service.

Body
required
namestring[ 2 .. 32 ] charactersrequired

Name of the SD-LAN service.

{
  "name": "string"
}

Responses

Accepted

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

Delete SD-LAN Service

Request

Path
sdLanServiceIdstringrequired

The ID of SD-LAN Service.

No request payload

Responses

Accepted

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

Partial SD-LAN Service

Request

Path
sdLanServiceIdstringrequired

The ID of SD-LAN Service.

Body
required
namestring[ 2 .. 32 ] charactersrequired

Name of the SD-LAN service.

{
  "name": "string"
}

Responses

Accepted

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

Activate Network in SD-LAN

Request

Activate the network in SD-LAN service.

Path
sdLanServiceIdstringrequired

The ID of SD-LAN Service.

wifiNetworkIdstringrequired

The ID of the tunneled network.

Body
required
isGuestTunnelUtilizedboolean

Is this network tunneled to guest edge.

{
  "isGuestTunnelUtilized": true
}

Responses

Accepted

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

Deactivate Network in SD-LAN

Request

Deactivate the network in SD-LAN service.

Path
sdLanServiceIdstringrequired

The ID of SD-LAN Service.

wifiNetworkIdstringrequired

The ID of the tunneled network.

No request payload

Responses

Accepted

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

Activate Network in SD-LAN for a Specific Venue

Request

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

Path
sdLanServiceIdstringrequired

The ID of SD-LAN Service.

venueIdstringrequired

The ID of the Venue.

wifiNetworkIdstringrequired

The ID of the tunneled network.

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 Network in SD-LAN for a Specific Venue

Request

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

Path
sdLanServiceIdstringrequired

The ID of SD-LAN Service.

venueIdstringrequired

The ID of the Venue.

wifiNetworkIdstringrequired

The ID of the tunneled network.

No request payload

Responses

Accepted

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

Create SD-LAN Service

Request

Body
required
namestring[ 2 .. 32 ] charactersrequired

Name of the SD-LAN service.

applyTostring

Scope where the SD-LAN service is applied to. Supported values: MY_ACCOUNT (current account), MY_CUSTOMERS (managed customers; MSP-EC tenants only), BOTH (current account and managed customers).

Default "MY_ACCOUNT"
Enum"BOTH""MY_ACCOUNT""MY_CUSTOMERS"
tunnelProfileIdstring[ 0 .. 255 ] characters

The tunnel profile identifier of the SD-LAN service.

tunnelTemplateIdstring[ 0 .. 255 ] characters

The tunnel template identifier of the SD-LAN service.

{
  "name": "string",
  "applyTo": "BOTH",
  "tunnelProfileId": "string",
  "tunnelTemplateId": "string"
}

Responses

Accepted

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

Query the Edge Compatibility of Services

Request

Query the compatibility info of Edge by SD-LAN services.

Body
required
filtersobject(ServiceEdgeCompatibilityFilter)required
filters.​serviceIdsArray of strings
{
  "filters": {
    "serviceIds": [ … ]
  }
}

Responses

OK

Body
compatibilitiesArray of objects(ServiceIncompatibleInfoDto)
Response
{
  "compatibilities": [
    { … }
  ]
}

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