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

Get Personal Identity Network Profile

Request

Get personal identity network by id.

Path
pinIdstringrequired
No request payload

Responses

OK

Body
idstring

ID of the personal identity network service.

namestring

Name of the personal identity network service.

vxlanTunnelProfileIdstring

ID of the tunnel profile used by the personal identity network service.

networkSegmentConfigurationobject(NetworkSegmentConfiguration)
distributionSwitchInfosArray of objects(DistributionSwitchInfo)
accessSwitchInfosArray of objects(AccessSwitchInfo)
Response
{
  "id": "string",
  "name": "string",
  "vxlanTunnelProfileId": "string",
  "networkSegmentConfiguration": {
    "segments": 0,
    "dhcpInfoId": "string",
    "dhcpPoolId": "string"
  },
  "distributionSwitchInfos": [
    { … }
  ],
  "accessSwitchInfos": [
    { … }
  ]
}

Update Personal Identity Network Profile

Request

Updates the personal identity network by unique identifier.

Path
pinIdstringrequired
Body
required
namestringnon-emptyrequired
networkSegmentConfigurationobject(NetworkSegmentConfiguration)required
networkSegmentConfiguration.​segmentsinteger(int32)
networkSegmentConfiguration.​dhcpInfoIdstring
networkSegmentConfiguration.​dhcpPoolIdstring
distributionSwitchInfosArray of objects(DistributionSwitchInfo)
accessSwitchInfosArray of objects(AccessSwitchInfo)
{
  "name": "string",
  "networkSegmentConfiguration": {
    "segments": 0,
    "dhcpInfoId": "string",
    "dhcpPoolId": "string"
  },
  "distributionSwitchInfos": [
    { … }
  ],
  "accessSwitchInfos": [
    { … }
  ]
}

Responses

Accepted

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

Delete Personal Identity Network Profile

Request

Delete personal identity network by id.

Path
pinIdstringrequired
No request payload

Responses

Accepted

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

Partial Update Personal Identity Network Profile

Request

Partial update of the personal identity network by id.

Path
pinIdstringrequired
Body
required
namestringnon-emptyrequired
networkSegmentConfigurationobject(NetworkSegmentConfiguration)required
networkSegmentConfiguration.​segmentsinteger(int32)
networkSegmentConfiguration.​dhcpInfoIdstring
networkSegmentConfiguration.​dhcpPoolIdstring
distributionSwitchInfosArray of objects(DistributionSwitchInfo)
accessSwitchInfosArray of objects(AccessSwitchInfo)
{
  "name": "string",
  "networkSegmentConfiguration": {
    "segments": 0,
    "dhcpInfoId": "string",
    "dhcpPoolId": "string"
  },
  "distributionSwitchInfos": [
    { … }
  ],
  "accessSwitchInfos": [
    { … }
  ]
}

Responses

Accepted

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

Activate Network in Personal Identity Network Profile

Request

Activate the network in personal identity network.

Path
pinIdstringrequired
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": [
    { … }
  ]
}

Deactivate Network in Personal Identity Network Profile

Request

Deactivate the network in personal identity network.

Path
pinIdstringrequired
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": [
    { … }
  ]
}

Retrieve Personal Identity Network Profile

Request

Retrieve list of personal identity network.

Query
pageinteger(int32)>= 1

Page index

Default 1
pageSizeinteger(int32)>= 20

The size of the page to be returned

Default 20
No request payload

Responses

OK

Body
contentArray of objects(PersonalIdentityNetworkResponseDto)
pagingobject(Paging)
Response
{
  "content": [
    { … }
  ],
  "paging": {
    "page": 0,
    "pageSize": 0,
    "totalCount": 0
  }
}

Create Personal Identity Network Profile

Request

Create personal identity networks.

Body
required
namestringnon-emptyrequired
vxlanTunnelProfileIdstringnon-emptyrequired
networkSegmentConfigurationobject(NetworkSegmentConfiguration)required
networkSegmentConfiguration.​segmentsinteger(int32)
networkSegmentConfiguration.​dhcpInfoIdstring
networkSegmentConfiguration.​dhcpPoolIdstring
distributionSwitchInfosArray of objects(DistributionSwitchInfo)
accessSwitchInfosArray of objects(AccessSwitchInfo)
{
  "name": "string",
  "vxlanTunnelProfileId": "string",
  "networkSegmentConfiguration": {
    "segments": 0,
    "dhcpInfoId": "string",
    "dhcpPoolId": "string"
  },
  "distributionSwitchInfos": [
    { … }
  ],
  "accessSwitchInfos": [
    { … }
  ]
}

Responses

Accepted

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

Query Edge Personal Identification Network Service Compatibility Information

Request

Query edge personal identity network service compatibility information.

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

Responses

OK

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

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