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.
Region | Domain Name |
---|---|
Asia | https://api.asia.ruckus.cloud |
Europe | https://api.eu.ruckus.cloud |
North America | https://api.ruckus.cloud |
Manage the Personal Identity Network services for Edge devices
Retrieve list of personal identity network.
page | integer <int32> >= 1 Default: 1 Page index |
pageSize | integer <int32> >= 20 Default: 20 The size of the page to be returned |
{- "content": [
- {
- "accessSwitchInfos": [
- {
- "distributionSwitchId": "string",
- "id": "string",
- "templateId": "string",
- "uplinkInfo": {
- "uplinkId": "string",
- "uplinkType": "string"
}, - "vlanId": "string",
- "webAuthCustomBottom": "string",
- "webAuthCustomLoginButton": "string",
- "webAuthCustomTitle": "string",
- "webAuthCustomTop": "string",
- "webAuthPageType": "string",
- "webAuthPasswordLabel": "string"
}
], - "distributionSwitchInfos": [
- {
- "id": "string",
- "loopbackInterfaceId": "string",
- "loopbackInterfaceIp": "string",
- "loopbackInterfaceSubnetMask": "string",
- "siteKeepAlive": "string",
- "siteRetry": "string",
- "vlans": "string"
}
], - "edgeClusterInfo": {
- "dhcpInfoId": "string",
- "dhcpPoolId": "string",
- "edgeClusterId": "string",
- "segments": 0
}, - "id": "string",
- "name": "string",
- "vxlanTunnelProfileId": "string"
}
], - "paging": {
- "page": 0,
- "pageSize": 0,
- "totalCount": 0
}
}
Create personal identity networks.
Array of objects (AccessSwitchInfo) | |
Array of objects (DistributionSwitchInfo) | |
required | object (EdgeClusterInfo) Edge Cluster Information Resource. |
name required | string |
vxlanTunnelProfileId required | string |
{- "accessSwitchInfos": [
- {
- "distributionSwitchId": "string",
- "id": "string",
- "templateId": "string",
- "uplinkInfo": {
- "uplinkId": "string",
- "uplinkType": "string"
}, - "vlanId": "string",
- "webAuthCustomBottom": "string",
- "webAuthCustomLoginButton": "string",
- "webAuthCustomTitle": "string",
- "webAuthCustomTop": "string",
- "webAuthPageType": "string",
- "webAuthPasswordLabel": "string"
}
], - "distributionSwitchInfos": [
- {
- "id": "string",
- "loopbackInterfaceId": "string",
- "loopbackInterfaceIp": "string",
- "loopbackInterfaceSubnetMask": "string",
- "siteKeepAlive": "string",
- "siteRetry": "string",
- "vlans": "string"
}
], - "edgeClusterInfo": {
- "dhcpInfoId": "string",
- "dhcpPoolId": "string",
- "edgeClusterId": "string",
- "segments": 0
}, - "name": "string",
- "vxlanTunnelProfileId": "string"
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Query edge personal identity network service compatibility information.
required | object (ServiceEdgeCompatibilityFilter) The filters for querying the services of the compatibility. |
{- "filters": {
- "serviceIds": [
- "string"
]
}
}
{- "compatibilities": [
- {
- "clusterEdgeCompatibilities": [
- {
- "id": "string",
- "identityType": "string",
- "incompatible": 0,
- "incompatibleFeatures": [
- {
- "featureRequirement": {
- "featureName": "string",
- "requiredFw": "string"
}, - "incompatibleDevices": [
- {
- "count": 0,
- "firmware": "string"
}
]
}
], - "total": 0
}
], - "serviceId": "string"
}
]
}
Delete personal identity network by id.
pinId required | string |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Get personal identity network by id.
pinId required | string |
{- "accessSwitchInfos": [
- {
- "distributionSwitchId": "string",
- "id": "string",
- "templateId": "string",
- "uplinkInfo": {
- "uplinkId": "string",
- "uplinkType": "string"
}, - "vlanId": "string",
- "webAuthCustomBottom": "string",
- "webAuthCustomLoginButton": "string",
- "webAuthCustomTitle": "string",
- "webAuthCustomTop": "string",
- "webAuthPageType": "string",
- "webAuthPasswordLabel": "string"
}
], - "distributionSwitchInfos": [
- {
- "id": "string",
- "loopbackInterfaceId": "string",
- "loopbackInterfaceIp": "string",
- "loopbackInterfaceSubnetMask": "string",
- "siteKeepAlive": "string",
- "siteRetry": "string",
- "vlans": "string"
}
], - "edgeClusterInfo": {
- "dhcpInfoId": "string",
- "dhcpPoolId": "string",
- "edgeClusterId": "string",
- "segments": 0
}, - "id": "string",
- "name": "string",
- "vxlanTunnelProfileId": "string"
}
Partial update of the personal identity network by id.
pinId required | string |
Array of objects (AccessSwitchInfo) | |
Array of objects (DistributionSwitchInfo) | |
required | object (EdgeClusterInfo) Edge Cluster Information Resource. |
name required | string |
vxlanTunnelProfileId required | string |
{- "accessSwitchInfos": [
- {
- "distributionSwitchId": "string",
- "id": "string",
- "templateId": "string",
- "uplinkInfo": {
- "uplinkId": "string",
- "uplinkType": "string"
}, - "vlanId": "string",
- "webAuthCustomBottom": "string",
- "webAuthCustomLoginButton": "string",
- "webAuthCustomTitle": "string",
- "webAuthCustomTop": "string",
- "webAuthPageType": "string",
- "webAuthPasswordLabel": "string"
}
], - "distributionSwitchInfos": [
- {
- "id": "string",
- "loopbackInterfaceId": "string",
- "loopbackInterfaceIp": "string",
- "loopbackInterfaceSubnetMask": "string",
- "siteKeepAlive": "string",
- "siteRetry": "string",
- "vlans": "string"
}
], - "edgeClusterInfo": {
- "dhcpInfoId": "string",
- "dhcpPoolId": "string",
- "edgeClusterId": "string",
- "segments": 0
}, - "name": "string",
- "vxlanTunnelProfileId": "string"
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Updates the personal identity network by unique identifier.
pinId required | string |
Array of objects (AccessSwitchInfo) | |
Array of objects (DistributionSwitchInfo) | |
required | object (EdgeClusterInfo) Edge Cluster Information Resource. |
name required | string |
vxlanTunnelProfileId required | string |
{- "accessSwitchInfos": [
- {
- "distributionSwitchId": "string",
- "id": "string",
- "templateId": "string",
- "uplinkInfo": {
- "uplinkId": "string",
- "uplinkType": "string"
}, - "vlanId": "string",
- "webAuthCustomBottom": "string",
- "webAuthCustomLoginButton": "string",
- "webAuthCustomTitle": "string",
- "webAuthCustomTop": "string",
- "webAuthPageType": "string",
- "webAuthPasswordLabel": "string"
}
], - "distributionSwitchInfos": [
- {
- "id": "string",
- "loopbackInterfaceId": "string",
- "loopbackInterfaceIp": "string",
- "loopbackInterfaceSubnetMask": "string",
- "siteKeepAlive": "string",
- "siteRetry": "string",
- "vlans": "string"
}
], - "edgeClusterInfo": {
- "dhcpInfoId": "string",
- "dhcpPoolId": "string",
- "edgeClusterId": "string",
- "segments": 0
}, - "name": "string",
- "vxlanTunnelProfileId": "string"
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Deactivate the network in personal identity network.
pinId required | string |
wifiNetworkId required | string The ID of the tunneled network. |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Activate the network in personal identity network.
pinId required | string |
wifiNetworkId required | string The ID of the tunneled network. |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
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. |
{- "edgeClusterId": "string",
- "name": "string",
- "tunnelProfileId": "string"
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Query the compatibility info of Edge by SD-LAN services.
required | object (ServiceEdgeCompatibilityFilter) The filters for querying the services of the compatibility. |
{- "filters": {
- "serviceIds": [
- "string"
]
}
}
{- "compatibilities": [
- {
- "clusterEdgeCompatibilities": [
- {
- "id": "string",
- "identityType": "string",
- "incompatible": 0,
- "incompatibleFeatures": [
- {
- "featureRequirement": {
- "featureName": "string",
- "requiredFw": "string"
}, - "incompatibleDevices": [
- {
- "count": 0,
- "firmware": "string"
}
]
}
], - "total": 0
}
], - "serviceId": "string"
}
]
}
sdLanServiceId required | string The ID of SD-LAN Service. |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
sdLanServiceId required | string The ID of SD-LAN Service. |
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. |
{- "edgeClusterId": "string",
- "name": "string",
- "tunnelProfileId": "string"
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
sdLanServiceId required | string The ID of SD-LAN Service. |
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. |
{- "edgeClusterId": "string",
- "name": "string",
- "tunnelProfileId": "string"
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Update guest settings in SD-LAN service.
sdLanServiceId required | string The ID of SD-LAN Service. |
isGuestTunnelEnabled | boolean Set true if guest tunnel is needed. |
{- "isGuestTunnelEnabled": true
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Deactivate the guest tunnel in SD-LAN service.
sdLanServiceId required | string The ID of SD-LAN Service. |
tunnelProfileId required | string The ID of the guest tunnel profile. |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Activate the guest tunnel in SD-LAN service.
sdLanServiceId required | string The ID of SD-LAN Service. |
tunnelProfileId required | string The ID of the guest tunnel profile. |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Deactivate the guest Edge cluster in SD-LAN service.
sdLanServiceId required | string The ID of SD-LAN Service. |
venueId required | string The ID of Venue. |
edgeClusterId required | string The ID of Edge Cluster. |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Activate the guest Edge cluster in SD-LAN service.
sdLanServiceId required | string The ID of SD-LAN Service. |
venueId required | string The ID of Venue. |
edgeClusterId required | string The ID of Edge Cluster. |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Activate the network in SD-LAN service for a specific venue.
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. |
isGuestTunnelUtilized | boolean Is this network tunneled to guest edge. |
{- "isGuestTunnelUtilized": true
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Deactivate the network in SD-LAN service.
sdLanServiceId required | string The ID of SD-LAN Service. |
wifiNetworkId required | string The ID of the tunneled network. |
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}
Activate the network in SD-LAN service.
sdLanServiceId required | string The ID of SD-LAN Service. |
wifiNetworkId required | string The ID of the tunneled network. |
isGuestTunnelUtilized | boolean Is this network tunneled to guest edge. |
{- "isGuestTunnelUtilized": true
}
{- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
], - "requestId": "string",
- "response": { }
}