API docs by Redocly

RUCKUS ONE Experimental APIs

License: RUCKUS Cloud Privacy Policy

Overview

The following are a list of experimental and beta APIs that are available to the RUCKUS One Beta customers. RUCKUS
reserves the right to change these experimental APIs without notice to API client developers. The process for
authenticating is detailed in the Overview section of our APIs. For the APIs presented here,
the highest level version is the experimental API, and all lower versions are qualified. Please see the
versioning section of our API for more information. For Role Based Access functionality, only the latest
version of the APIs will support custom roles.

RUCKUS One API Hosts

Region Domain Name
Asia https://api.asia.ruckus.cloud
Europe https://api.eu.ruckus.cloud
North America https://api.ruckus.cloud

Edge Personal Identity Network Service

Manage the Personal Identity Network services for Edge devices

Retrieve Personal Identity Network Profile

Retrieve list of personal identity network.

query Parameters
page
integer <int32> >= 1
Default: 1

Page index

pageSize
integer <int32> >= 20
Default: 20

The size of the page to be returned

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "paging": {
    }
}

Create Personal Identity Network Profile

Create personal identity networks.

Request Body schema:
required
Array of objects (AccessSwitchInfo)
Array of objects (DistributionSwitchInfo)
required
object (EdgeClusterInfo)

Edge Cluster Information Resource.

name
required
string
vxlanTunnelProfileId
required
string

Responses

Request samples

Content type
{
  • "accessSwitchInfos": [
    ],
  • "distributionSwitchInfos": [
    ],
  • "edgeClusterInfo": {
    },
  • "name": "string",
  • "vxlanTunnelProfileId": "string"
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Query Edge Personal Identification Network Service Compatibility Information

Query edge personal identity network service compatibility information.

Request Body schema:
required
required
object (ServiceEdgeCompatibilityFilter)

The filters for querying the services of the compatibility.

Responses

Request samples

Content type
{
  • "filters": {
    }
}

Response samples

Content type
{
  • "compatibilities": [
    ]
}

Delete Personal Identity Network Profile

Delete personal identity network by id.

path Parameters
pinId
required
string

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Get Personal Identity Network Profile

Get personal identity network by id.

path Parameters
pinId
required
string

Responses

Response samples

Content type
{
  • "accessSwitchInfos": [
    ],
  • "distributionSwitchInfos": [
    ],
  • "edgeClusterInfo": {
    },
  • "id": "string",
  • "name": "string",
  • "vxlanTunnelProfileId": "string"
}

Partial Update Personal Identity Network Profile

Partial update of the personal identity network by id.

path Parameters
pinId
required
string
Request Body schema:
required
Array of objects (AccessSwitchInfo)
Array of objects (DistributionSwitchInfo)
required
object (EdgeClusterInfo)

Edge Cluster Information Resource.

name
required
string
vxlanTunnelProfileId
required
string

Responses

Request samples

Content type
{
  • "accessSwitchInfos": [
    ],
  • "distributionSwitchInfos": [
    ],
  • "edgeClusterInfo": {
    },
  • "name": "string",
  • "vxlanTunnelProfileId": "string"
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Update Personal Identity Network Profile

Updates the personal identity network by unique identifier.

path Parameters
pinId
required
string
Request Body schema:
required
Array of objects (AccessSwitchInfo)
Array of objects (DistributionSwitchInfo)
required
object (EdgeClusterInfo)

Edge Cluster Information Resource.

name
required
string
vxlanTunnelProfileId
required
string

Responses

Request samples

Content type
{
  • "accessSwitchInfos": [
    ],
  • "distributionSwitchInfos": [
    ],
  • "edgeClusterInfo": {
    },
  • "name": "string",
  • "vxlanTunnelProfileId": "string"
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Deactivate Network in Personal Identity Network Profile

Deactivate the network in personal identity network.

path Parameters
pinId
required
string
wifiNetworkId
required
string

The ID of the tunneled network.

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Activate Network in Personal Identity Network Profile

Activate the network in personal identity network.

path Parameters
pinId
required
string
wifiNetworkId
required
string

The ID of the tunneled network.

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Edge SD-LAN Service

Manage the SD-LAN services for Edge devices

Create SD-LAN Service

Request Body schema:
required
edgeClusterId
required
string

The edge cluster identifier of the SD-LAN service.

name
required
string [ 2 .. 32 ] characters

Name of the SD-LAN service.

tunnelProfileId
required
string [ 0 .. 255 ] characters

The ID of the tunnel profile used for tunneling AP traffic to the Edge cluster.

Responses

Request samples

Content type
{
  • "edgeClusterId": "string",
  • "name": "string",
  • "tunnelProfileId": "string"
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Query the Edge Compatibility of Services

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

Request Body schema:
required
required
object (ServiceEdgeCompatibilityFilter)

The filters for querying the services of the compatibility.

Responses

Request samples

Content type
{
  • "filters": {
    }
}

Response samples

Content type
{
  • "compatibilities": [
    ]
}

Delete SD-LAN Service

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Get SD-LAN Service

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

Responses

Response samples

Content type
{
  • "edgeClusterId": "string",
  • "id": "string",
  • "name": "string",
  • "requestId": "string",
  • "tunnelProfileId": "string"
}

Partial SD-LAN Service

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

Request Body schema:
required
edgeClusterId
required
string

The edge cluster identifier of the SD-LAN service.

name
required
string [ 2 .. 32 ] characters

Name of the SD-LAN service.

tunnelProfileId
required
string [ 0 .. 255 ] characters

The ID of the tunnel profile used for tunneling AP traffic to the Edge cluster.

Responses

Request samples

Content type
{
  • "edgeClusterId": "string",
  • "name": "string",
  • "tunnelProfileId": "string"
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Update SD-LAN Service

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

Request Body schema:
required
edgeClusterId
required
string

The edge cluster identifier of the SD-LAN service.

name
required
string [ 2 .. 32 ] characters

Name of the SD-LAN service.

tunnelProfileId
required
string [ 0 .. 255 ] characters

The ID of the tunnel profile used for tunneling AP traffic to the Edge cluster.

Responses

Request samples

Content type
{
  • "edgeClusterId": "string",
  • "name": "string",
  • "tunnelProfileId": "string"
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Get Guest Settings

Get the guest settings in SD-LAN service.

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

Responses

Response samples

Content type
{
  • "isGuestTunnelEnabled": true
}

Update Guest Settings

Update guest settings in SD-LAN service.

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

Request Body schema:
required
isGuestTunnelEnabled
boolean

Set true if guest tunnel is needed.

Responses

Request samples

Content type
{
  • "isGuestTunnelEnabled": true
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Deactivate Guest Tunnel

Deactivate the guest tunnel in SD-LAN service.

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

tunnelProfileId
required
string

The ID of the guest tunnel profile.

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Activate Guest Tunnel

Activate the guest tunnel in SD-LAN service.

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

tunnelProfileId
required
string

The ID of the guest tunnel profile.

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Deactivate Guest Edge Cluster

Deactivate the guest Edge cluster in SD-LAN service.

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

venueId
required
string

The ID of Venue.

edgeClusterId
required
string

The ID of Edge Cluster.

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Activate Guest Edge Cluster

Activate the guest Edge cluster in SD-LAN service.

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

venueId
required
string

The ID of Venue.

edgeClusterId
required
string

The ID of Edge Cluster.

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Activate Network in SD-LAN for a Specific Venue

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

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

venueId
required
string

The ID of the Venue.

wifiNetworkId
required
string

The ID of the tunneled network.

Request Body schema:
required
isGuestTunnelUtilized
boolean

Is this network tunneled to guest edge.

Responses

Request samples

Content type
{
  • "isGuestTunnelUtilized": true
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Deactivate Network in SD-LAN

Deactivate the network in SD-LAN service.

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

wifiNetworkId
required
string

The ID of the tunneled network.

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}

Activate Network in SD-LAN

Activate the network in SD-LAN service.

path Parameters
sdLanServiceId
required
string

The ID of SD-LAN Service.

wifiNetworkId
required
string

The ID of the tunneled network.

Request Body schema:
required
isGuestTunnelUtilized
boolean

Is this network tunneled to guest edge.

Responses

Request samples

Content type
{
  • "isGuestTunnelUtilized": true
}

Response samples

Content type
{
  • "links": [
    ],
  • "requestId": "string",
  • "response": { }
}