APIs published in this document are subject to strict change control by RUCKUS. As far as possible, when new versions of the Public API are published, all documented API endpoints will maintain backward compatibility. When not possible, an API endpoint will be deprecated and a replacement API or some other workaround will be provided. Support for deprecated API endpoints will continue for at least six months prior to removal in order to provide API client developers sufficient time to adopt the replacement. This document will indicate when API endpoints are deprecated along with the schedule for their removal. API client developers may discover other experimental API endpoints provided by the RUCKUS cloud, not included in this API document. RUCKUS reserves the right to change these experimental APIs without notice to API client developers.
Document Name | Resources Managed |
wifi-ns-220111.html | Wi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks. |
msp-ns-220111.html | MSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks. |
platform-ns-220111.html | Platform related resources. This document describes API endpoints related to your account including administrators and their notification preferences, venues and your entitlements/licenses. |
switch-ns-220111.html | ICX switch related resources. This document describes API endpoints related to managing your switches and wired networks. |
Region | Domain |
Asia | https://asia.ruckus.cloud |
Europe | https://eu.ruckus.cloud |
North America | https://ruckus.cloud |
Deprecated URL | Replacement URL |
/api/tenant/{tenantId}/wifi/ap/{serialNumber}/dhcp | /api/tenant/{tenantId}/wifi/ap/{serialNumber}/dhcp/usage |
API clients use an API-KEY to access REST endpoints. In order to obtain an API-KEY, an administrator uses the endpoints in the "API Client Authentication" group, available on all cloud hosts. The API-KEY issued will have the same access privileges (aka role) as the administrator who obtained the key. Please see document platform-ns-220111.html for details.
Security Scheme Type | API Key |
---|---|
Header parameter name: | Cookie |
API Group | New Summary | New Description |
Access Control Profile | Delete Multiple Access Control Profiles | Delete multiple access control profiles by profile identities. |
Access Control Profile | Get All Access Control Profiles | Get all access control profiles. |
Access Control Profile | Add Access Control Profile | Add an access control profile. |
Access Control Profile | Query Access Control Profiles | Get access control profiles by query. |
Access Control Profile | Delete Access Control Profile | Delete the specified access control profile. |
Access Control Profile | Get Access Control Profile | Get an access control profile by profile identity. |
Access Control Profile | Update Access Control Profile | Update the specified access control profile. |
API endpoints in this group provide the functions outlined in the table below.
Category | Functions Provided by AP Group Endpoints |
AP Resource | Create, read, update and delete AP resources (i.e., the APs themselves), one at a time or per a list. |
Customize | Configure radio and LAN port parameters. For some AP models, configure external antenna parameters and PoE power sourcing. Note that customizations done on individual APs (i.e., by endpoints in this API group) override customizations done at the venue, by endpoints in the “AP-Venue” API group. |
Position | Set/update the AP’s position on a floorplan. |
Regulatory | Get a list of radio channels permitted for operation by the regulatory domain in which the AP is physically located. |
Services | Configure Bonjour gateway services. |
Troubleshooting | Reboot, factory reset, ping, traceroute, packet capture and blink LEDs. Note: blinking an AP’s LEDs can be helpful in identifying a specific AP for positioning on a floorplan. |
Get the AP list.
tenantId required | string Tenant ID |
operational | boolean Default: true |
page | integer <int32> |
size | integer <int32> |
[- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
]
Add a list of new APs.
tenantId required | string Tenant ID |
serialNumber required | string^[1-9][0-9]{11}$ |
apGroupId | string |
venueId required | string |
name required | string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$ |
description | string [ 0 .. 180 ] characters |
tags | Array of strings [ 0 .. 24 ] items |
model | string [ 0 .. 64 ] characters Default: "null" |
object (ApPosition) AP position object |
[- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
]
{- "requestId": "string",
- "response": {
- "downloadUrl": "string",
- "txId": "string",
- "fileErrorsCount": 0,
- "errors": [
- {
- "code": 0,
- "description": "string"
}
]
}
}
Delete a list of APs.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get AP radio details.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
{- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}
Update an AP radio settings.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
object (ApRadioParams24G) AP radio customization for 2.4GHz. | |
object (ApRadioParams50G) AP radio customization for 5GHz. | |
useVenueSettings | boolean Default: true |
enable24G | boolean Default: false |
enable50G | boolean Default: false |
{- "apRadioParams24G": {
- "manualChannel": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}
{- "requestId": "string",
- "response": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}
}
Reset AP radio to default settings.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}
}
Get the APs in the AP-group.
apGroupId required | string AP-group ID |
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
]
Get the AP operational and configuration data.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
operational | boolean Default: true |
{- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "lanPorts": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}, - "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
Update an AP.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
serialNumber required | string^[1-9][0-9]{11}$ |
apGroupId | string |
venueId required | string |
name required | string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$ |
description | string [ 0 .. 180 ] characters |
tags | Array of strings [ 0 .. 24 ] items |
model | string [ 0 .. 64 ] characters Default: "null" |
object (ApPosition) AP position object |
{- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
{- "requestId": "string",
- "response": {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
}
Get the AP operational and configuration data, including nested details.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
{- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "lanPorts": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}, - "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
Get a list of AP DHCP configurations by AP serial number.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": [
- {
- "serialNumber": "stringstring",
- "dhcpApRole": "PrimaryServer",
- "venueId": "string",
- "venueDhcpEnabled": true,
- "venueDhcpMode": "EnableOnEachAPs"
}
]
}
Get AP LAN-ports details.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
{- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}
Update LAN-ports of an AP.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
poeOut | boolean Default: false |
Array of objects (ApLanPort) | |
useVenueSettings | boolean Default: false |
{- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}
{- "requestId": "string",
- "response": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}
}
Reset the LAN-ports of an AP to the default values.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": { }
}
GET AP customization details.
serialNumber required | string |
tenantId required | string Tenant ID |
{- "externalAntenna": {
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "supportDisable": false,
- "coupled": false
}, - "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false,
- "id": "string"
}
Update the customization of an AP.
serialNumber required | string |
tenantId required | string Tenant ID |
object (ExternalAntenna) External antenna settings | |
poeOut | boolean Default: false |
Array of objects (ApLanPort) | |
useVenueSettings | boolean Default: false |
{- "externalAntenna": {
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "supportDisable": false,
- "coupled": false
}, - "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}
{- "requestId": "string",
- "response": {
- "externalAntenna": {
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "supportDisable": false,
- "coupled": false
}, - "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false,
- "id": "string"
}
}
Update an AP floor-plan position.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
floorplanId | string |
xPercent | number <float> [ 0 .. 100 ] Default: 0 |
yPercent | number <float> [ 0 .. 100 ] Default: 0 |
{- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
{- "requestId": "string",
- "response": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
Get the AP Bonjour gateway details.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
{- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}
Update the AP Bonjour gateway.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
required | Array of objects (BonjourGatewayRule) [ 1 .. 2147483647 ] items |
{- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}
{- "requestId": "string",
- "response": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}
}
Command requesting this AP ping a host on the network.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
targetHost required | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
{- "targetHost": "string"
}
{- "requestId": "string",
- "response": {
- "response": "string"
}
}
Perform a trace-route on an AP.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
targetHost required | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
{- "targetHost": "string"
}
{- "requestId": "string",
- "response": {
- "response": "string"
}
}
Get DHCP pool usage.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
[- {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "totalIpCount": 0,
- "usedIpCount": 0,
- "id": "string"
}
]
Get the IP address leases issued by the DHCP server instance running on this AP.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
[- {
- "leaseExpiration": "string",
- "hostname": "string",
- "ipAddress": "string",
- "dhcpProfileId": "string",
- "dhcpProfileName": "string",
- "macAddress": "string",
- "status": "string"
}
]
Blink an AP's LED lights.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": {
- "response": "string"
}
}
Get packet capture state.
tenantId required | string Tenant ID |
serialNumber required | string |
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Start packet capture.
tenantId required | string Tenant ID |
serialNumber required | string |
captureInterface required | string^RADIO(24|50)$|^ETH[0-7]$ |
macAddressFilter | string^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$|... |
frameTypeFilter | Array of strings Items Enum: "MANAGEMENT" "CONTROL" "DATA" |
{- "captureInterface": "string",
- "macAddressFilter": "string",
- "frameTypeFilter": [
- "MANAGEMENT"
]
}
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Stop packet capture.
tenantId required | string Tenant ID |
serialNumber required | string |
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Get this AP's regulatory channels. Note: these channel numbers are specific to the country in which the AP is deployed.
serialNumber required | string AP serialNumber |
tenantId required | string Tenant ID |
{- "2.4GChannels": {
- "auto": [
- "1"
], - "20MHz": [
- "1"
], - "40MHz": [
- "1"
]
}, - "5GChannels": {
- "indoor": {
- "auto": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "160MHz": [
- "36"
]
}, - "outdoor": {
- "auto": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "160MHz": [
- "36"
]
}
}
}
Get AP picture.
tenantId required | string Tenant ID |
serialNumber required | string |
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Upload AP picture.
tenantId required | string Tenant ID |
serialNumber required | string |
file | string <binary> |
{- "file": "string"
}
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Delete AP picture.
tenantId required | string Tenant ID |
serialNumber required | string |
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Manage AP groups.
Grouping APs is typically done to restrict the deployment of certain WLANs to only the APs in a group rather than all the APs in a venue. Using AP groups, WLANs can be enabled on either the 2.4-GHz or 5-GHz band instead of both bands (which is the default). Use the endpoints in the “Network-Venue” API group for managing WLAN (network) assignments to AP Groups.
Get the AP-group details.
apGroupId required | string AP-group ID |
tenantId required | string Tenant ID |
{- "venueId": "string",
- "aps": [
- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "lanPorts": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}, - "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
], - "isDefault": false,
- "name": "string",
- "description": "string",
- "id": "string"
}
Update an AP-group.
Note: AP-Groups cannot be moved between venues, but a single AP can be moved between venues using the update AP endpoint.
apGroupId required | string AP-group ID |
tenantId required | string Tenant ID |
venueId required | string |
Array of objects (ApSerialNumber) | |
name required | string [ 2 .. 64 ] characters |
description | string [ 2 .. 180 ] characters |
{- "venueId": "string",
- "apSerialNumbers": [
- {
- "serialNumber": "string",
- "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "description": "string"
}
{- "requestId": "string",
- "response": {
- "venueId": "string",
- "aps": [
- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "lanPorts": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}, - "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
], - "isDefault": false,
- "name": "string",
- "description": "string",
- "id": "string"
}
}
Get venue default AP-group details.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "venueId": "string",
- "aps": [
- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "lanPorts": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}, - "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
], - "isDefault": false,
- "name": "string",
- "description": "string",
- "id": "string"
}
Get the AP-group list.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "venueId": "string",
- "aps": [
- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "lanPorts": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}, - "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
], - "isDefault": false,
- "name": "string",
- "description": "string",
- "id": "string"
}
]
Create a new AP-group.
tenantId required | string Tenant ID |
venueId required | string |
Array of objects (ApSerialNumber) | |
name required | string [ 2 .. 64 ] characters |
description | string [ 2 .. 180 ] characters |
{- "venueId": "string",
- "apSerialNumbers": [
- {
- "serialNumber": "string",
- "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "description": "string"
}
{- "requestId": "string",
- "response": {
- "venueId": "string",
- "aps": [
- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "lanPorts": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}, - "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
], - "isDefault": false,
- "name": "string",
- "description": "string",
- "id": "string"
}
}
Delete a list of AP-groups.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get the AP-group list by venue.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "venueId": "string",
- "aps": [
- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "lanPorts": {
- "poeOut": false,
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "useVenueSettings": false
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "service": "AIRDISK",
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "fromVlan": 1,
- "toVlan": 1
}
]
}, - "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "txPower": "TxPowerEnum.MAX"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "null",
- "subState": "null",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "model": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
], - "isDefault": false,
- "name": "string",
- "description": "string",
- "id": "string"
}
]
API endpoints in this group provide the functions outlined in the table below. All the APs in the venue will share a common configuration which is managed using these endpoints. Note that customization done on individual APs (i.e., by endpoints in the “AP” API group) override customization done at the venue level, by endpoints in this group.
Category | Functions Provided by AP-Venue Group Endpoints |
Customize | Configure the APs’ radio and LAN port parameters. Configure APs to turn off/on their LEDs. Configure external antenna parameters used by all AP models having external antenna capability. Configure cellular radio parameters used by al AP models having cellular backhaul capability. |
Mesh Networking | Enable or disable mesh networking in a venue. |
Network Protection | Configure rogue AP detection and classification policies; view reports on detected rogue APs. |
Regulatory | Get a list of LTE radio bands available for operation. |
Services | Configure vSPoT services. Configure APs to use a syslog server which is external to the RUCKUS cloud. |
Update venue LED settings. The settings are defined per AP model.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
ledEnabled | boolean Default: false |
model | string [ 0 .. 64 ] characters |
[- {
- "ledEnabled": false,
- "model": "string"
}
]
{- "requestId": "string",
- "response": [
- {
- "ledEnabled": false,
- "model": "string"
}
]
}
List venue external antenna settings. The settings are defined per AP model.
venueId required | string |
tenantId required | string Tenant ID |
[- {
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "model": "string"
}
]
Update a venue external antenna settings. The settings are defined per AP model.
venueId required | string |
tenantId required | string Tenant ID |
enable24G | boolean Default: false |
enable50G | boolean Default: false |
gain24G | integer <int32> [ 0 .. 60 ] |
gain50G | integer <int32> [ 0 .. 60 ] |
model | string [ 0 .. 64 ] characters |
[- {
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "model": "string"
}
]
{- "requestId": "string",
- "response": [
- {
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "model": "string"
}
]
}
Get the venue radio.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}
}
Update the venue radio.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
object (RadioParams24G) Radio customization for 2.4GHz. | |
object (RadioParams50G) Radio customization for 5GHz. |
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}
}
{- "requestId": "string",
- "response": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}
}
}
Reset venue radio to default values.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}
}
}
Get the venue radio default values.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}
}
Get venue default regulatory channels.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "2.4GChannels": {
- "auto": [
- "1"
], - "20MHz": [
- "1"
], - "40MHz": [
- "1"
]
}, - "5GChannels": {
- "indoor": {
- "auto": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "160MHz": [
- "36"
]
}, - "outdoor": {
- "auto": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "160MHz": [
- "36"
]
}
}
}
Get this venue's rogue-AP configuration settings.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "enabled": false,
- "reportThreshold": 0,
- "roguePolicyId": "string"
}
Update this venue's rogue-AP configuration settings.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
enabled | boolean Default: false |
reportThreshold | integer <int32> [ 0 .. 100 ] Default: 0 |
roguePolicyId | string |
{- "enabled": false,
- "reportThreshold": 0,
- "roguePolicyId": "string"
}
{- "requestId": "string",
- "response": {
- "enabled": false,
- "reportThreshold": 0,
- "roguePolicyId": "string"
}
}
Get the venue syslog settings.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "FacilityEnum.KEEP_ORIGINAL",
- "priority": "PriorityEnum.INFO",
- "protocol": "ProtocolEnum.UDP",
- "flowLevel": "FlowLevelEnum.CLIENT_FLOW",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "ProtocolEnum.TCP"
}
Update the venue syslog settings.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
enabled | boolean Default: false |
server | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
port | integer <int32> [ 1 .. 65535 ] Default: 514 |
facility | string Default: "FacilityEnum.KEEP_ORIGINAL" Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7" |
priority | string Default: "PriorityEnum.INFO" Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL" |
protocol | string Default: "ProtocolEnum.UDP" Enum: "TCP" "UDP" |
flowLevel | string Default: "FlowLevelEnum.CLIENT_FLOW" Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL" |
secondaryServer | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
secondaryPort | integer <int32> [ 1 .. 65535 ] Default: 514 |
secondaryProtocol | string Default: "ProtocolEnum.TCP" Enum: "TCP" "UDP" |
{- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "FacilityEnum.KEEP_ORIGINAL",
- "priority": "PriorityEnum.INFO",
- "protocol": "ProtocolEnum.UDP",
- "flowLevel": "FlowLevelEnum.CLIENT_FLOW",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "ProtocolEnum.TCP"
}
{- "requestId": "string",
- "response": {
- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "FacilityEnum.KEEP_ORIGINAL",
- "priority": "PriorityEnum.INFO",
- "protocol": "ProtocolEnum.UDP",
- "flowLevel": "FlowLevelEnum.CLIENT_FLOW",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "ProtocolEnum.TCP"
}
}
Reset venue syslog settings to default values.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": {
- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "FacilityEnum.KEEP_ORIGINAL",
- "priority": "PriorityEnum.INFO",
- "protocol": "ProtocolEnum.UDP",
- "flowLevel": "FlowLevelEnum.CLIENT_FLOW",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "ProtocolEnum.TCP"
}
}
Get this venue's DoS protection.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "enabled": false,
- "blockingPeriod": 60,
- "failThreshold": 5,
- "checkPeriod": 30
}
Update this venue's DoS protection.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
enabled | boolean Default: false |
blockingPeriod | integer <int32> [ 30 .. 600 ] Default: 60 |
failThreshold | integer <int32> [ 2 .. 25 ] Default: 5 |
checkPeriod | integer <int32> [ 30 .. 600 ] Default: 30 |
{- "enabled": false,
- "blockingPeriod": 60,
- "failThreshold": 5,
- "checkPeriod": 30
}
{- "requestId": "string",
- "response": {
- "enabled": false,
- "blockingPeriod": 60,
- "failThreshold": 5,
- "checkPeriod": 30
}
}
Get the venue Wi-Fi details.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "tenantId": "string",
- "countryCode": "string",
- "apPassword": "string",
- "wifiFirmwareVersion": "string",
- "mesh": {
- "enabled": false
}, - "bandBalancing": {
- "enabled": false,
- "clientPercent24": "string"
}, - "radioCustomization": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}
}, - "denialOfServiceProtection": {
- "enabled": false,
- "blockingPeriod": 60,
- "failThreshold": 5,
- "checkPeriod": 30
}, - "syslog": {
- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "FacilityEnum.KEEP_ORIGINAL",
- "priority": "PriorityEnum.INFO",
- "protocol": "ProtocolEnum.UDP",
- "flowLevel": "FlowLevelEnum.CLIENT_FLOW",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "ProtocolEnum.TCP"
}, - "dhcpServiceSetting": {
- "enabled": false,
- "mode": "DhcpModeEnum.EnableOnEachAPs",
- "wanPortSelectionMode": "DhcpWanPortSelectionModeEnum.Dynamic",
- "dhcpServiceProfileIds": [
- "string"
], - "wifiFirmwareVersion": "string",
- "dhcpServiceAps": [
- {
- "serialNumber": "stringstring",
- "role": "PrimaryServer",
- "dhcpIps": [
- "string"
]
}
], - "enableClientIsolationAllowlist": false
}, - "lteBandLockChannels": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "rogueAp": {
- "enabled": false,
- "reportThreshold": 0,
- "roguePolicyId": "string"
}, - "enableClientIsolationAllowlist": false,
- "id": "string"
}
List venue LAN-port settings. The settings are defined per AP model.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
[- {
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "model": "string",
- "poeOut": false,
- "poeMode": "Auto"
}
]
Update a venue LAN-port settings. The settings are defined per AP model.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
Array of objects (VenueLanPort) | |
model | string [ 0 .. 64 ] characters |
poeOut | boolean Default: false |
poeMode | string Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8" |
[- {
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "model": "string",
- "poeOut": false,
- "poeMode": "Auto"
}
]
{- "requestId": "string",
- "response": [
- {
- "lanPorts": [
- {
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string",
- "portId": "string",
- "enabled": true
}
], - "model": "string",
- "poeOut": false,
- "poeMode": "Auto"
}
]
}
Get the venue list of Wi-Fi details.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "tenantId": "string",
- "countryCode": "string",
- "apPassword": "string",
- "wifiFirmwareVersion": "string",
- "mesh": {
- "enabled": false
}, - "bandBalancing": {
- "enabled": false,
- "clientPercent24": "string"
}, - "radioCustomization": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "ChannelBandwidth24GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "ChannelBandwidth5GEnum.AUTO",
- "method": "ScanMethodEnum.BACKGROUND_SCANNING",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "TxPowerEnum.MAX"
}
}, - "denialOfServiceProtection": {
- "enabled": false,
- "blockingPeriod": 60,
- "failThreshold": 5,
- "checkPeriod": 30
}, - "syslog": {
- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "FacilityEnum.KEEP_ORIGINAL",
- "priority": "PriorityEnum.INFO",
- "protocol": "ProtocolEnum.UDP",
- "flowLevel": "FlowLevelEnum.CLIENT_FLOW",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "ProtocolEnum.TCP"
}, - "dhcpServiceSetting": {
- "enabled": false,
- "mode": "DhcpModeEnum.EnableOnEachAPs",
- "wanPortSelectionMode": "DhcpWanPortSelectionModeEnum.Dynamic",
- "dhcpServiceProfileIds": [
- "string"
], - "wifiFirmwareVersion": "string",
- "dhcpServiceAps": [
- {
- "serialNumber": "stringstring",
- "role": "PrimaryServer",
- "dhcpIps": [
- "string"
]
}
], - "enableClientIsolationAllowlist": false
}, - "lteBandLockChannels": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "rogueAp": {
- "enabled": false,
- "reportThreshold": 0,
- "roguePolicyId": "string"
}, - "enableClientIsolationAllowlist": false,
- "id": "string"
}
]
Enable/disable the venue mesh.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
enabled | boolean Default: false |
{- "enabled": false
}
{- "requestId": "string",
- "response": {
- "enabled": false
}
}
Get the vSPoT details of a venue.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "serverName": "string",
- "vspotGlobalId": "string",
- "serverAddress": "string",
- "port": 8883,
- "password": "stringst",
- "id": "string"
}
Bind a venue to the vSPoT server.
venueId required | string Venue ID |
vspotId required | string vSPoT ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "serverName": "string",
- "vspotGlobalId": "string",
- "serverAddress": "string",
- "port": 8883,
- "password": "stringst",
- "id": "string"
}
}
Get AP model cellular settings and LTE band lock channels of the venue.
venueId required | string |
tenantId required | string Tenant ID |
{- "model": "string",
- "primarySim": {
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "enabled": true,
- "apn": "string",
- "roaming": true,
- "networkSelection": "AUTO"
}, - "secondarySim": {
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "enabled": true,
- "apn": "string",
- "roaming": true,
- "networkSelection": "AUTO"
}, - "wanConnection": "ETH_WITH_CELLULAR_FAILOVER",
- "primaryWanRecoveryTimer": 10
}
Update AP model cellular settings and LTE band lock channels of the venue.
venueId required | string |
tenantId required | string Tenant ID |
model | string [ 0 .. 64 ] characters |
object (SimSettings) SIM setting object. | |
object (SimSettings) SIM setting object. | |
wanConnection required | string Enum: "ETH_WITH_CELLULAR_FAILOVER" "CELLULAR_WITH_ETH_FAILOVER" "ETH" "CELLULAR" |
primaryWanRecoveryTimer required | integer <int32> [ 10 .. 300 ] |
{- "model": "string",
- "primarySim": {
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "enabled": true,
- "apn": "string",
- "roaming": true,
- "networkSelection": "AUTO"
}, - "secondarySim": {
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "enabled": true,
- "apn": "string",
- "roaming": true,
- "networkSelection": "AUTO"
}, - "wanConnection": "ETH_WITH_CELLULAR_FAILOVER",
- "primaryWanRecoveryTimer": 10
}
{- "requestId": "string",
- "response": {
- "model": "string",
- "primarySim": {
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "enabled": true,
- "apn": "string",
- "roaming": true,
- "networkSelection": "AUTO"
}, - "secondarySim": {
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "enabled": true,
- "apn": "string",
- "roaming": true,
- "networkSelection": "AUTO"
}, - "wanConnection": "ETH_WITH_CELLULAR_FAILOVER",
- "primaryWanRecoveryTimer": 10
}
}
Get a list of this venue’s DHCP service settings.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "enabled": false,
- "mode": "DhcpModeEnum.EnableOnEachAPs",
- "wanPortSelectionMode": "DhcpWanPortSelectionModeEnum.Dynamic",
- "dhcpServiceProfileIds": [
- "string"
], - "wifiFirmwareVersion": "string",
- "dhcpServiceAps": [
- {
- "serialNumber": "stringstring",
- "role": "PrimaryServer",
- "dhcpIps": [
- "string"
]
}
], - "enableClientIsolationAllowlist": false
}
Update this venue’s DHCP service settings.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
enabled | boolean Default: false |
mode | string Default: "DhcpModeEnum.EnableOnEachAPs" Enum: "EnableOnEachAPs" "EnableOnMultipleAPs" "EnableOnHierarchicalAPs" |
wanPortSelectionMode | string Default: "DhcpWanPortSelectionModeEnum.Dynamic" Enum: "Dynamic" "Manual" |
dhcpServiceProfileIds | Array of strings |
wifiFirmwareVersion | string |
Array of objects (DhcpServiceAp) | |
enableClientIsolationAllowlist | boolean Default: false |
{- "enabled": false,
- "mode": "DhcpModeEnum.EnableOnEachAPs",
- "wanPortSelectionMode": "DhcpWanPortSelectionModeEnum.Dynamic",
- "dhcpServiceProfileIds": [
- "string"
], - "wifiFirmwareVersion": "string",
- "dhcpServiceAps": [
- {
- "serialNumber": "stringstring",
- "role": "PrimaryServer",
- "dhcpIps": [
- "string"
]
}
], - "enableClientIsolationAllowlist": false
}
{- "requestId": "string",
- "response": {
- "enabled": false,
- "mode": "DhcpModeEnum.EnableOnEachAPs",
- "wanPortSelectionMode": "DhcpWanPortSelectionModeEnum.Dynamic",
- "dhcpServiceProfileIds": [
- "string"
], - "wifiFirmwareVersion": "string",
- "dhcpServiceAps": [
- {
- "serialNumber": "stringstring",
- "role": "PrimaryServer",
- "dhcpIps": [
- "string"
]
}
], - "enableClientIsolationAllowlist": false
}
}
Get a list of the venue’s DHCP pools’ usage.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
[- {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "totalIpCount": 0,
- "usedIpCount": 0,
- "id": "string"
}
]
Get a list of the venue’s DHCP leases.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
[- {
- "leaseExpiration": "string",
- "hostname": "string",
- "ipAddress": "string",
- "dhcpProfileId": "string",
- "dhcpProfileName": "string",
- "macAddress": "string",
- "status": "string"
}
]
Get available LTE bands for each region.
tenantId required | string Tenant ID |
[- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1",
- "countryCodes": [
- "string"
]
}
]
API endpoints in this group provide the capability to create and manage the network types outlined in the table below.
WLAN Type | Network Schema Object | Description |
PSK | PskNetwork | Wireless network in which clients use a PSK to join the WLAN. In addition to PSK authentication, MAC address authentication can be configured. When MAC address authentication is used, an authentication server (aka AAA server) and optionally an accounting server must be configured. The object “PskWlan” object is used to configure the security method (e.g., WPA2, WPA3), whether management frame protection (802.11w) is enabled and a static VLAN ID with which client frames egressing the AP are tagged (used when the authentication server does not provide a VLAN assignment). For advanced customization of a PSK WLAN, the “PskWlanAdvancedCustomization” schema object can optionally be included; advanced customization features are described below. |
DPSK | DpskNetwork | Wireless network in which clients use DPSK authentication to join the WLAN. Configuring DPSK authentication involves the use of three other schema objects, “DpskWlan”, “DpskWlanAdvancedCustomization” and “DpskPassphraseGeneration”. DpskWlan is used to configure the SSID, a static VLAN ID (used when the authentication service does not provide a VLAN assignment) and DpskWlanAdvancedCustomization is optionally used for advanced customizations (see below). Note that configuring a AAA server is not required for a DPSK network because it’s provided by the RUCKUS cloud. DpskPassphraseGeneration is used to configure the syntax for the DPSKs (i.e., the pre-shared key values) supplied to your end users. API endpoints in the “DPSK Passphrases” group are used to create and manage passphrases. |
Enterprise AAA (802.1X) | AAANetwork | Wireless network in which clients are authenticated using 802.1X and an EAP method. Thus, an authentication server (aka AAA server) and optionally an accounting server are needed and are configured using the AAANetwork schema object. Configuring an enterprise AAA network involves the use of two other schema objects, “AAAWlan” and “AAAWlanAdvancedCustomization”. AAAWlan is used to configure the SSID and a static VLAN ID (used when the authentication service does not provide a VLAN assignment). “AAAWlanAdvancedCustomization” is used for advanced customizations (see below). |
Captive Portal | GuestNetwork | Wireless network in which clients are authenticated using a captive portal; over-the-air communication between the AP and clients can be open (no encryption) or secured by a passphrase. Configuring a guest network involves the use of 4 main schema objects, “GuestWlan”, “GuestPage”, “GuestPortal” and “GuestWlanAdvancedCustomization”. You can configure an external portal provider or use the portal provided by the RUCKUS cloud. If you choose the latter, GuestPage configures the branding and text for the portal page. GuestWlan is used to configure the SSID, a static VLAN ID, WLAN security and whether MAC address authentication is used in addition to the captive portal. If used and the client’s MAC address is known to the authentication server (aka AAA server), captive portal authentication can be bypassed depending on the value of the property, “bypassCPUsingMacAddressAuthentication”. If WLAN security is other than “None”, management frame protection (802.11w) can be configured. RUCKUS cloud supports WiFi4EU, applicable to public networks deployed in Europe. This option is configured using the GuestPage schema object. The object, GuestPortal, determines the type of captive portal to be used for the WLAN. The options are:
“GuestWlanAdvancedCustomization” is used for advanced customizations (see below). |
Open | OpenNetwork | Wireless network in which clients just join without any authentication or over-the-air security. Note: this type of network is considered insecure and is not recommended. Configuring an open network involves the use of two other schema objects, “OpenWlan” and “OpenWlanAdvancedCustomization”. OpenWlan is used to configure the SSID and a static VLAN ID. “OpenWlanAdvancedCustomization” is used for advanced customizations (see below). |
Get the network details.
networkId required | string Network ID |
tenantId required | string Tenant ID |
{- "type": "aaa",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadiusId": "string",
- "accountingRadiusId": "string",
- "tenantId": "string",
- "cloudpathServerId": "string",
- "name": "string",
- "description": "string",
- "enableAuthProxy": false,
- "enableAccountingProxy": false,
- "id": "string"
}
Update this network, including nested details.
networkId required | string Network ID |
tenantId required | string Tenant ID |
type required | string aaa aaa dpsk guest open psk |
required | object (AAAWlan) WLAN |
authRadiusId | string |
accountingRadiusId | string |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
description | string [ 0 .. 255 ] characters |
enableAuthProxy | boolean Default: false |
enableAccountingProxy | boolean Default: false |
{- "type": "aaa",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
]
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadiusId": "string",
- "accountingRadiusId": "string",
- "name": "string",
- "description": "string",
- "enableAuthProxy": false,
- "enableAccountingProxy": false
}
{- "requestId": "string",
- "response": {
- "type": "string"
}
}
Create a new network (deep).
tenantId required | string Tenant ID |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
Array of objects (NetworkVenue) | |
description | string [ 0 .. 255 ] characters |
type required | string aaa aaa psk guest open DpskNetworkDeep |
required | object (AAAWlan) WLAN |
object (Radius) Primary and secondary radius servers. | |
object (Radius) Primary and secondary radius servers. | |
enableAuthProxy | boolean Default: false |
enableAccountingProxy | boolean Default: false |
{- "name": "string",
- "id": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both"
}
], - "tenantId": "string",
- "description": "string",
- "type": "aaa",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
]
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
}, - "enableAuthProxy": false,
- "enableAccountingProxy": false
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "id": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
], - "tenantId": "string",
- "description": "string",
- "type": "string",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "cloudpathServerId": "string",
- "enableAuthProxy": false,
- "enableAccountingProxy": false
}
}
Get network details, including nested details.
networkId required | string Network ID |
tenantId required | string Tenant ID |
{- "name": "string",
- "id": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
], - "tenantId": "string",
- "description": "string",
- "type": "aaa",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "cloudpathServerId": "string",
- "enableAuthProxy": false,
- "enableAccountingProxy": false
}
Update a network and manage network-venue activations.
networkId required | string Network ID |
tenantId required | string Tenant ID |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
Array of objects (NetworkVenue) | |
description | string [ 0 .. 255 ] characters |
type required | string aaa aaa psk guest open DpskNetworkDeep |
required | object (AAAWlan) WLAN |
object (Radius) Primary and secondary radius servers. | |
object (Radius) Primary and secondary radius servers. | |
enableAuthProxy | boolean Default: false |
enableAccountingProxy | boolean Default: false |
{- "name": "string",
- "id": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both"
}
], - "tenantId": "string",
- "description": "string",
- "type": "aaa",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
]
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
}, - "enableAuthProxy": false,
- "enableAccountingProxy": false
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "id": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
], - "tenantId": "string",
- "description": "string",
- "type": "string",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "cloudpathServerId": "string",
- "enableAuthProxy": false,
- "enableAccountingProxy": false
}
}
Get the network list.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
{- "type": "aaa",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadiusId": "string",
- "accountingRadiusId": "string",
- "tenantId": "string",
- "cloudpathServerId": "string",
- "name": "string",
- "description": "string",
- "enableAuthProxy": false,
- "enableAccountingProxy": false,
- "id": "string"
}
Create a new network.
tenantId required | string Tenant ID |
type required | string aaa aaa dpsk guest open psk |
required | object (AAAWlan) WLAN |
authRadiusId | string |
accountingRadiusId | string |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
description | string [ 0 .. 255 ] characters |
enableAuthProxy | boolean Default: false |
enableAccountingProxy | boolean Default: false |
{- "type": "aaa",
- "wlan": {
- "advancedCustomization": {
- "devicePolicyId": "string",
- "l2AclPolicyId": "string",
- "l3AclPolicyId": "string",
- "applicationPolicyId": "string",
- "accessControlProfileId": "string",
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "totalDownlinkRateLimiting": 0,
- "maxClientsOnWlanPerRadio": 100,
- "enableBandBalancing": true,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "packetsType": "UNICAST",
- "autoVrrp": false
}, - "hideSsid": false,
- "forceMobileDeviceDhcp": false,
- "clientLoadBalancingEnable": true,
- "enableAaaVlanOverride": true,
- "directedThreshold": 5,
- "enableNeighborReport": true,
- "enableFastRoaming": false,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "rfBandUsage": "RfBandUsageEnum.BOTH",
- "bssMinimumPhyRate": "BssMinimumPhyRateEnum._default",
- "phyTypeConstraint": "PhyTypeConstraintEnum.OFDM",
- "managementFrameMinimumPhyRate": "ManagementFrameMinimumPhyRateEnum._6"
}, - "enableSyslog": false,
- "clientInactivityTimeout": 120,
- "accessControlEnable": false,
- "respectiveAccessControl": true,
- "vlanPool": {
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
]
}, - "applicationPolicyEnable": false,
- "l2AclEnable": false,
- "l3AclEnable": false,
- "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
], - "singleSessionIdAccounting": false,
- "proxyARP": false,
- "enableAirtimeDecongestion": false,
- "enableJoinRSSIThreshold": false,
- "joinRSSIThreshold": -85,
- "enableTransientClientManagement": false,
- "joinWaitTime": 30,
- "joinExpireTime": 300,
- "joinWaitThreshold": 10,
- "enableOptimizedConnectivityExperience": false,
- "broadcastProbeResponseDelay": 15,
- "rssiAssociationRejectionThreshold": -75,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "arpRequestRateLimit": 15,
- "enableDhcpRequestRateLimit": true,
- "dhcpRequestRateLimit": 15,
- "dnsProxyEnabled": false,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}
}, - "vlanId": 1,
- "ssid": "string",
- "enabled": true,
- "bypassCPUsingMacAddressAuthentication": false,
- "bypassCNA": false
}, - "authRadiusId": "string",
- "accountingRadiusId": "string",
- "name": "string",
- "description": "string",
- "enableAuthProxy": false,
- "enableAccountingProxy": false
}
{- "requestId": "string",
- "response": {
- "type": "string"
}
}
Delete a list of networks.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get the list of external WISPr providers for a captive portal network. Note: these providers have integrated their service with the RUCKUS cloud.
tenantId required | string Tenant ID |
{- "providers": [
- {
- "name": "string",
- "regions": [
- {
- "name": "string",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": "string"
}, - "secondary": {
- "ip": "string",
- "port": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": "string"
}, - "secondary": {
- "ip": "string",
- "port": "string"
}
}, - "captivePortalUrl": "string",
- "redirectUrl": "string",
- "showAnalyticsData": false,
- "externalProviderUrl": "string"
}
], - "customExternalProvider": false
}
]
}
Get the DPSK passphrase format list.
tenantId required | string Tenant ID |
[- {
- "dpskPassphraseGeneration": {
- "length": 18,
- "format": "PassphraseFormatEnum.MOST_SECURED",
- "expiration": "PassphraseExpirationEnum.UNLIMITED"
}, - "name": "string",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "cloudpathServer": {
- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "CloudpathDeploymentTypeEnum.OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "id": "string"
}, - "id": "string"
}
]
Validate the X509 certificate chain issued by a trusted CA.
tenantId required | string Tenant ID |
required | object (X509Certificate) X509 certificate |
Array of objects (X509Certificate) | |
info | string |
{- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Manage network activation in venues.
Note that simply creating a WLAN (network) does not deploy it to a venue's APs. To deploy a WLAN, it must be “activated” on a venue. When a network is activated, it can be activated for all the APs in the venue or just on certain AP groups (cf. “Create Network-Venue" description). Also, the network can be activated on a schedule so that it will enabled only during specified times of a day and days of a week — i.e., it will automatically be turned on and off per the schedule.
Create a new network-venue activation.
tenantId required | string Tenant ID |
venueId | string |
networkId | string |
clientIsolationAllowlistId | string |
Array of objects (NetworkApGroup) | |
object (NetworkVenueScheduler) Network-Venue scheduler | |
isAllApGroups | boolean Default: true |
allApGroupsVlanId | integer <int32> [ 1 .. 4094 ] |
vlanPoolId | string |
allApGroupsRadio | string Default: "RadioEnum.Both" Enum: "Both" "2.4-GHz" "5-GHz" |
{- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both"
}
{- "requestId": "string",
- "response": {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
}
Delete a list of network-venue activation.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get the network-venue activation details.
networkVenueId required | string Network-Venue ID |
tenantId required | string Tenant ID |
{- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
Update this network-venue activation.
networkVenueId required | string Network-Venue ID |
tenantId required | string Tenant ID |
venueId | string |
networkId | string |
clientIsolationAllowlistId | string |
Array of objects (NetworkApGroup) | |
object (NetworkVenueScheduler) Network-Venue scheduler | |
isAllApGroups | boolean Default: true |
allApGroupsVlanId | integer <int32> [ 1 .. 4094 ] |
vlanPoolId | string |
allApGroupsRadio | string Default: "RadioEnum.Both" Enum: "Both" "2.4-GHz" "5-GHz" |
{- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both"
}
{- "requestId": "string",
- "response": {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
}
Get network-venue activation list.
networkId required | string Network ID |
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
]
Get venue-network activation list.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
]
Get a network-venue activation by network and venue.
networkId required | string Network ID |
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "RadioEnum.Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "scheduler": {
- "type": "SchedulerTypeEnum.ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "allApGroupsRadio": "RadioEnum.Both",
- "id": "string"
}
API endpoints in this group provide the capability to create and manage Cloudpath service. Note that in order to use Cloudpath service, customers must have a Cloudpath account (different than the account used to access the RUCKUS cloud).
Cloudpath service can be configured on the WLAN types described in the table below.
WLAN Type | Network Schema Objects | Description |
802.1X | AAANetwork | Cloudpath provides 802.1X authentication and authorization policy services. Authentication is based on EAP methods and credentials configured using your Cloudpath account. End-user accounts, which are containers of authorization policy, are also configured in your Cloudpath account. |
DPSK | DpskNetwork | Cloudpath provides DPSK authentication and authorization policy services. DPSK passphrases and end-user accounts (for authorization policy) are configured in your Cloudpath account. |
Guest | GuestNetwork | Cloudpath provides MAC address authentication and authorization policy services. If MAC addresses are registered (configured) in Cloudpath service and “bypassCPUsingMacAddressAuthentication” in the “GuestWlan” object is set to true, then the captive portal will be bypassed when a client device having a registered MAC address joins the WLAN. In addition, end-user accounts (containers for authorization policy) can be configured in Cloudpath service. Lastly, if desired, a Cloudpath guest portal can also be configured. |
Open | OpenNetwork | Cloudpath provides MAC address authentication and authorization policy services. MAC addresses to authenticate along with their corresponding end-user accounts for authorization policy are configured in Cloudpath account. |
Get a list of Cloudpath servers.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "CloudpathDeploymentTypeEnum.OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "id": "string"
}
]
Add a new Cloudpath server.
tenantId required | string Tenant ID |
deployedInVenueId | string |
deployedInVenueName | string |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
deploymentType | string Default: "CloudpathDeploymentTypeEnum.OnPremise" Enum: "OnPremise" "Cloud" |
required | object (Radius) Primary and secondary radius servers. |
object (Radius) Primary and secondary radius servers. | |
object (ApPosition) AP position object |
{- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "CloudpathDeploymentTypeEnum.OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
}, - "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
{- "requestId": "string",
- "response": {
- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "CloudpathDeploymentTypeEnum.OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "id": "string"
}
}
Delete a list of Cloudpath servers.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get details for this Cloudpath server.
cloudpathServerId required | string |
tenantId required | string Tenant ID |
{- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "CloudpathDeploymentTypeEnum.OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "id": "string"
}
Update the configuration of this Cloudpath server.
cloudpathServerId required | string |
tenantId required | string Tenant ID |
deployedInVenueId | string |
deployedInVenueName | string |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
deploymentType | string Default: "CloudpathDeploymentTypeEnum.OnPremise" Enum: "OnPremise" "Cloud" |
required | object (Radius) Primary and secondary radius servers. |
object (Radius) Primary and secondary radius servers. | |
object (ApPosition) AP position object |
{- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "CloudpathDeploymentTypeEnum.OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string"
}
}, - "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
{- "requestId": "string",
- "response": {
- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "CloudpathDeploymentTypeEnum.OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "tlsEnabled": false,
- "cnSanIdentity": "string",
- "ocspUrl": "string",
- "trustedCAChain": {
- "rootCert": {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}, - "interCerts": [
- {
- "certData": "string",
- "isRootCert": false,
- "fileName": "string"
}
], - "info": "string",
- "id": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "id": "string"
}
}
Test the connection to this Cloudpath server. Note: for on-premise deployments, the network using the Cloudpath server must be activated on the venue for this command to work properly.
cloudpathServerId required | string |
tenantId required | string Tenant ID |
{- "status": "Success",
- "failureReason": "string"
}
Update Cloudpath server floor-plan position.
cloudpathServerId required | string Cloudpath Server Id |
tenantId required | string Tenant ID |
floorplanId | string |
xPercent | number <float> [ 0 .. 100 ] Default: 0 |
yPercent | number <float> [ 0 .. 100 ] Default: 0 |
{- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
{- "requestId": "string",
- "response": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
Get this DPSK passphrase.
dpskPassphraseId required | string DPSK passphrase ID |
tenantId required | string Tenant ID |
{- "networkId": "string",
- "networkSsid": "string",
- "username": "string",
- "numberOfDevices": 1,
- "mac": "string",
- "passphrase": "stringst",
- "vlanId": 1,
- "numberOfDevicesType": "DpskNumberOfDevicesEnum.LIMITED",
- "expirationDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "createdDate": "2019-08-24T14:15:22Z"
}
Get the list of DPSK passphrases.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "networkId": "string",
- "networkSsid": "string",
- "username": "string",
- "numberOfDevices": 1,
- "mac": "string",
- "passphrase": "stringst",
- "vlanId": 1,
- "numberOfDevicesType": "DpskNumberOfDevicesEnum.LIMITED",
- "expirationDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "createdDate": "2019-08-24T14:15:22Z"
}
]
Create one or more DPSK passphrases.
tenantId required | string Tenant ID |
numberOfPassphrases | integer <int32> [ 1 .. 5000 ] Default: 1 |
override | boolean Default: false |
passphrase | string [ 8 .. 63 ] characters ^[ -~]{8,63}$ |
vlanId | integer <int32> [ 1 .. 4094 ] |
numberOfDevicesType | string Default: "DpskNumberOfDevicesEnum.LIMITED" Enum: "LIMITED" "UNLIMITED" |
numberOfDevices | integer <int32> [ 1 .. 50 ] Default: 1 |
username | string [ 0 .. 190 ] characters |
mac | string^([0-9A-Fa-f]{2}[.:-]){5}([0-9A-Fa-f]{2})$|^(... |
{- "numberOfPassphrases": 1,
- "override": false,
- "passphrase": "stringst",
- "vlanId": 1,
- "numberOfDevicesType": "DpskNumberOfDevicesEnum.LIMITED",
- "numberOfDevices": 1,
- "username": "string",
- "mac": "string"
}
{- "requestId": "string",
- "response": {
- "networkId": "string",
- "numberOfPassphrases": 1,
- "override": false,
- "passphrase": "stringst",
- "vlanId": 1,
- "numberOfDevicesType": "DpskNumberOfDevicesEnum.LIMITED",
- "numberOfDevices": 1,
- "username": "string",
- "mac": "string",
- "id": "string"
}
}
Delete a list of DPSK passphrases.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Query for a list of DPSK passphrases.
tenantId required | string Tenant ID |
object (DpskPassphraseFilters) Filters used to query DPSK passphrase. | |
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "filters": {
- "networkId": [
- "string"
], - "vlanId": [
- 0
], - "includeExpired": [
- true
], - "passphrase": [
- "string"
], - "mac": [
- "string"
], - "username": [
- "string"
]
}, - "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "data": [
- {
- "networkId": "string",
- "networkSsid": "string",
- "username": "string",
- "numberOfDevices": 1,
- "mac": "string",
- "passphrase": "stringst",
- "vlanId": 1,
- "numberOfDevicesType": "DpskNumberOfDevicesEnum.LIMITED",
- "expirationDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "createdDate": "2019-08-24T14:15:22Z"
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
Export all the unexpired DPSK passphrases in the database in a CSV-formatted file.
tenantId required | string |
timezone | string Default: "UTC" |
date-format | string Default: "dd/MM/yyyy HH:mm" |
object (DpskPassphraseFilters) Filters used to query DPSK passphrase. | |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "filters": {
- "networkId": [
- "string"
], - "vlanId": [
- 0
], - "includeExpired": [
- true
], - "passphrase": [
- "string"
], - "mac": [
- "string"
], - "username": [
- "string"
]
}, - "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Imports the DPSK passphrases provided in a CSV-formatted file.
tenantId required | string |
networkId required | string |
usernamePrefix | string [ 0 .. 190 ] characters |
file | string <binary> |
{- "file": "string"
}
{- "requestId": "string",
- "response": {
- "downloadUrl": "string",
- "data": [
- {
- "networkId": "string",
- "networkSsid": "string",
- "username": "string",
- "numberOfDevices": 1,
- "mac": "string",
- "passphrase": "stringst",
- "vlanId": 1,
- "numberOfDevicesType": "DpskNumberOfDevicesEnum.LIMITED",
- "expirationDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "createdDate": "2019-08-24T14:15:22Z"
}
]
}
}
Manage layer-2 ACL (access control list) policies. A layer-2 ACL policy is configured on a wireless network by including its ID in the advanced customization schema object used to create the network.
Layer-2 ACL policies allow an administrator control over the client devices permitted on a WLAN. A layer-2 policy includes a list of MAC addresses. The policy can be set up as a whitelist or a blacklist.
Get layer-2 ACL profile collection.
tenantId required | string Tenant ID |
[- {
- "name": "string",
- "description": "string",
- "access": "AccessEnum.BLOCK",
- "macAddresses": [
- "string"
], - "id": "string"
}
]
Add layer-2 ACL by profile.
tenantId required | string Tenant ID |
name required | string [ 2 .. 32 ] characters |
description | string |
access | string Default: "AccessEnum.BLOCK" Enum: "ALLOW" "BLOCK" |
macAddresses required | Array of strings [ 1 .. 128 ] items |
{- "name": "string",
- "description": "string",
- "access": "AccessEnum.BLOCK",
- "macAddresses": [
- "string"
]
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "description": "string",
- "access": "AccessEnum.BLOCK",
- "macAddresses": [
- "string"
], - "id": "string"
}
}
Delete layer-2 ACL profiles.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Query layer-2 ACL profile.
tenantId required | string Tenant ID |
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "data": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "macAddressesCount": 0,
- "networksCount": 0,
- "networksNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
Get layer-2 ACL by profile id.
l2AclPolicyId required | string L2Acl Policy ID |
tenantId required | string Tenant ID |
{- "name": "string",
- "description": "string",
- "access": "AccessEnum.BLOCK",
- "macAddresses": [
- "string"
], - "id": "string"
}
Update layer-2 ACL by profile id.
l2AclPolicyId required | string L2Acl Policy ID |
tenantId required | string Tenant ID |
name required | string [ 2 .. 32 ] characters |
description | string |
access | string Default: "AccessEnum.BLOCK" Enum: "ALLOW" "BLOCK" |
macAddresses required | Array of strings [ 1 .. 128 ] items |
{- "name": "string",
- "description": "string",
- "access": "AccessEnum.BLOCK",
- "macAddresses": [
- "string"
]
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "description": "string",
- "access": "AccessEnum.BLOCK",
- "macAddresses": [
- "string"
], - "id": "string"
}
}
Manage layer-3 ACL (access control list) policies. A layer-3 ACL policy is configured on a wireless network by including its ID in the advanced customization schema object used to create the network.
Layer-3 ACL policies allow an administrator control over the traffic sent and received by a client device. Layer-3 ACL policies are an ordered set of rules applied to all client devices associated to a wireless network. Each rule yields an allow/block decision and is applied to the packet (IP datagram) if it matches the rule’s 5-tuple. If the outcome is allow, the packet is forwarded; if the outcome is block, the packet is filtered (dropped). The rules are processed in order until an allow or block decision is reached. If the 5-tuple in the first rule does not match the packet, the next rule is evaluated and so on. The last rule in the set is either “allow all” or “block all” so that if none of the rules match, an unambiguous outcome is still reached. All layer-3 ACLs are applied to packets upon ingress to an AP. The 5-tuple is comprised of the following fields taken from the packet’s IP header:
Get layer-3 ACL profile collection.
tenantId required | string Tenant ID |
[- {
- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "AccessEnum.ALLOW",
- "protocol": "L3ProtocolEnum_TCP",
- "customProtocol": 1,
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "id": "string"
}
], - "id": "string"
}
]
Add layer-3 ACL by profile.
tenantId required | string Tenant ID |
name required | string [ 2 .. 32 ] characters |
description | string |
defaultAccess | string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK" |
Array of objects (L3Rule) [ 1 .. 128 ] items |
{- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "AccessEnum.ALLOW",
- "protocol": "L3ProtocolEnum_TCP",
- "customProtocol": 1,
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "AccessEnum.ALLOW",
- "protocol": "L3ProtocolEnum_TCP",
- "customProtocol": 1,
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "id": "string"
}
], - "id": "string"
}
}
Delete layer-3 ACL profiles.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Query layer-3 ACL profile.
tenantId required | string Tenant ID |
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "data": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "rulesCount": 0,
- "networksCount": 0,
- "networksNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
Get layer-3 ACL by profile id.
l3AclPolicyId required | string L3Acl Policy ID |
tenantId required | string Tenant ID |
{- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "AccessEnum.ALLOW",
- "protocol": "L3ProtocolEnum_TCP",
- "customProtocol": 1,
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "id": "string"
}
], - "id": "string"
}
Update layer-3 ACL by profile id.
l3AclPolicyId required | string L3Acl Policy ID |
tenantId required | string Tenant ID |
name required | string [ 2 .. 32 ] characters |
description | string |
defaultAccess | string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK" |
Array of objects (L3Rule) [ 1 .. 128 ] items |
{- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "AccessEnum.ALLOW",
- "protocol": "L3ProtocolEnum_TCP",
- "customProtocol": 1,
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "AccessEnum.ALLOW",
- "protocol": "L3ProtocolEnum_TCP",
- "customProtocol": 1,
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "id": "string"
}
], - "id": "string"
}
}
Manage device policies. A device policy policy is configured on a wireless network by including its ID in the advanced customization schema object used to create the network.
Device policies allow an administrator control over the manner in which devices, having certain operating systems, use your wireless network. After a device joins the WLAN, the RUCKUS cloud determines the brand of OS installed on the device. Based on that brand, device policy can allow continued access or deny access. In the latter case, the device is disconnected from the network. Additionally, downstream and/or upstream rate limiting can be applied as well as assignment of the device to a specific VLAN.
Get the device-policy details.
devicePolicyId required | string Device-policy ID |
tenantId required | string Tenant ID |
{- "tenantId": "string",
- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "AccessEnum.ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
], - "id": "string"
}
Update a device-policy.
devicePolicyId required | string Device-policy ID |
tenantId required | string Tenant ID |
name required | string [ 2 .. 32 ] characters |
description | string [ 2 .. 180 ] characters |
defaultAccess | string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK" |
Array of objects (DevicePolicyRule) [ 1 .. 32 ] items |
{- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "AccessEnum.ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "AccessEnum.ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
], - "id": "string"
}
}
Get the device-policy collection.
tenantId required | string Tenant ID |
[- {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "AccessEnum.ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
], - "id": "string"
}
]
Create a new device-policy.
tenantId required | string Tenant ID |
name required | string [ 2 .. 32 ] characters |
description | string [ 2 .. 180 ] characters |
defaultAccess | string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK" |
Array of objects (DevicePolicyRule) [ 1 .. 32 ] items |
{- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "AccessEnum.ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "defaultAccess": "AccessEnum.ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "AccessEnum.ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
], - "id": "string"
}
}
Delete a list of device-policies.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get the device-policy list.
tenantId required | string Tenant ID |
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "data": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "rulesCount": 0,
- "networksCount": 0,
- "networksNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
Manage application policies. An application policy is configured on a wireless network by including its ID in the advanced customization schema object used to create the network.
Application policies allow an administrator control over the applications client devices are permitted to access via a WLAN. Administrators can block access to particular services, allow rate-limited access or modify the QoS policy used for access. For example, an administrator could use an application policy rule to block access to a social media website.
Use this API command to get the application policy list.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "rules": [
- {
- "name": "string",
- "ruleType": "SIGNATURE",
- "accessControl": "DENY",
- "priority": 0,
- "category": "string",
- "categoryId": 0,
- "applicationName": "string",
- "applicationId": 0,
- "uplink": 250,
- "downlink": 250,
- "markingPriority": "IEEE802_1P",
- "upLinkMarkingType": "VOICE",
- "downLinkMarkingType": "VOICE",
- "portMapping": "IP_WITH_PORT",
- "destinationIp": "string",
- "netmask": "string",
- "destinationPort": 1,
- "protocol": "TCP",
- "id": "string"
}
], - "id": "string"
}
]
Use this API command to create a new application policy.
tenantId required | string Tenant ID |
name required | string [ 2 .. 32 ] characters |
description | string [ 0 .. 64 ] characters |
Array of objects (ApplicationPolicyRule) [ 1 .. 128 ] items |
{- "name": "string",
- "description": "string",
- "rules": [
- {
- "name": "string",
- "ruleType": "SIGNATURE",
- "accessControl": "DENY",
- "priority": 0,
- "category": "string",
- "categoryId": 0,
- "applicationName": "string",
- "applicationId": 0,
- "uplink": 250,
- "downlink": 250,
- "markingPriority": "IEEE802_1P",
- "upLinkMarkingType": "VOICE",
- "downLinkMarkingType": "VOICE",
- "portMapping": "IP_WITH_PORT",
- "destinationIp": "string",
- "netmask": "string",
- "destinationPort": 1,
- "protocol": "TCP"
}
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "rules": [
- {
- "name": "string",
- "ruleType": "SIGNATURE",
- "accessControl": "DENY",
- "priority": 0,
- "category": "string",
- "categoryId": 0,
- "applicationName": "string",
- "applicationId": 0,
- "uplink": 250,
- "downlink": 250,
- "markingPriority": "IEEE802_1P",
- "upLinkMarkingType": "VOICE",
- "downLinkMarkingType": "VOICE",
- "portMapping": "IP_WITH_PORT",
- "destinationIp": "string",
- "netmask": "string",
- "destinationPort": 1,
- "protocol": "TCP",
- "id": "string"
}
], - "id": "string"
}
}
Use this API command to delete an application policy list.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Use this API command to get the application policy details.
applicationPolicyId required | string |
tenantId required | string Tenant ID |
{- "tenantId": "string",
- "name": "string",
- "description": "string",
- "rules": [
- {
- "name": "string",
- "ruleType": "SIGNATURE",
- "accessControl": "DENY",
- "priority": 0,
- "category": "string",
- "categoryId": 0,
- "applicationName": "string",
- "applicationId": 0,
- "uplink": 250,
- "downlink": 250,
- "markingPriority": "IEEE802_1P",
- "upLinkMarkingType": "VOICE",
- "downLinkMarkingType": "VOICE",
- "portMapping": "IP_WITH_PORT",
- "destinationIp": "string",
- "netmask": "string",
- "destinationPort": 1,
- "protocol": "TCP",
- "id": "string"
}
], - "id": "string"
}
Use this API command to update application policy.
applicationPolicyId required | string |
tenantId required | string Tenant ID |
name required | string [ 2 .. 32 ] characters |
description | string [ 0 .. 64 ] characters |
Array of objects (ApplicationPolicyRule) [ 1 .. 128 ] items |
{- "name": "string",
- "description": "string",
- "rules": [
- {
- "name": "string",
- "ruleType": "SIGNATURE",
- "accessControl": "DENY",
- "priority": 0,
- "category": "string",
- "categoryId": 0,
- "applicationName": "string",
- "applicationId": 0,
- "uplink": 250,
- "downlink": 250,
- "markingPriority": "IEEE802_1P",
- "upLinkMarkingType": "VOICE",
- "downLinkMarkingType": "VOICE",
- "portMapping": "IP_WITH_PORT",
- "destinationIp": "string",
- "netmask": "string",
- "destinationPort": 1,
- "protocol": "TCP"
}
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "rules": [
- {
- "name": "string",
- "ruleType": "SIGNATURE",
- "accessControl": "DENY",
- "priority": 0,
- "category": "string",
- "categoryId": 0,
- "applicationName": "string",
- "applicationId": 0,
- "uplink": 250,
- "downlink": 250,
- "markingPriority": "IEEE802_1P",
- "upLinkMarkingType": "VOICE",
- "downLinkMarkingType": "VOICE",
- "portMapping": "IP_WITH_PORT",
- "destinationIp": "string",
- "netmask": "string",
- "destinationPort": 1,
- "protocol": "TCP",
- "id": "string"
}
], - "id": "string"
}
}
Use this API command to get the application policy list by query.
tenantId required | string Tenant ID |
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "data": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "rulesCount": 0,
- "networksCount": 0,
- "networksNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
Get list of DHCP service-profiles.
tenantId required | string Tenant ID |
excludeDefault | boolean Default: false |
[- {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "id": "string"
}
]
Create a new DHCP service-profile.
tenantId required | string Tenant ID |
Array of objects (IdAndName) | |
name required | string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$ |
vlanId required | integer <int32> [ 1 .. 4094 ] |
subnetAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
subnetMask required | string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128... |
startIpAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
endIpAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
primaryDnsIp | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
secondaryDnsIp | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
leaseTimeHours required | integer <int32> [ 0 .. 24 ] |
leaseTimeMinutes required | integer <int32> [ 0 .. 59 ] |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59
}
{- "requestId": "string",
- "response": {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "id": "string"
}
}
Delete a list of DHCP service-profiles.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get the DHCP service-profile details.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
tenantId required | string Tenant ID |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "id": "string"
}
Update a DHCP service-profile.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
tenantId required | string Tenant ID |
Array of objects (IdAndName) | |
name required | string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$ |
vlanId required | integer <int32> [ 1 .. 4094 ] |
subnetAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
subnetMask required | string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128... |
startIpAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
endIpAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
primaryDnsIp | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
secondaryDnsIp | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
leaseTimeHours required | integer <int32> [ 0 .. 24 ] |
leaseTimeMinutes required | integer <int32> [ 0 .. 59 ] |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59
}
{- "requestId": "string",
- "response": {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "id": "string"
}
}
Delete a DHCP service-profile.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": { }
}
Get a venue's DHCP service profiles.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
[- {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "vlanId": 1,
- "subnetAddress": "string",
- "subnetMask": "string",
- "startIpAddress": "string",
- "endIpAddress": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "id": "string"
}
]
Manage DHCP service-profile assignments to venues. Note that simply creating a DHCP service profile does not deploy it to a venue's AP(s). To deploy a DHCP service profile, it must be “bound” to a venue.
Notes:
Update the DHCP service profiles bound to a venue.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": [
- {
- "venueId": "string",
- "dhcpServiceProfileId": "string"
}
]
}
Bind a DHCP service profile to a venue.
venueId required | string Venue ID |
dhcpServiceProfileId required | string DHCP Service-Profile ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": {
- "venueId": "string",
- "dhcpServiceProfileId": "string"
}
}
Unbind a DHCP service profile from a venue.
venueId required | string Venue ID |
dhcpServiceProfileId required | string DHCP Service-Profile ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": { }
}
Get the list of venues using a DHCP service profile.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
tenantId required | string Tenant ID |
[- {
- "venueId": "string",
- "dhcpServiceProfileId": "string"
}
]
Bind a DHCP service profile to a list of venues.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": [
- {
- "venueId": "string",
- "dhcpServiceProfileId": "string"
}
]
}
Unbind a DHCP service profile from a list of venues.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Manage rogue classification policies.
Rogue APs are Wi-Fi APs which are in radio range of your Wi-Fi network, but are unknown to the Ruckus cloud. For example, these may be APs in installed your venues without explicit authorization from your administrators, whether added by a well-meaning employee or by a malicious attacker; as such, they could be on the same LAN as your authorized APs. They could also be APs installed in nearby venues (for example, if your venue is part of a multi-tenant facility). Rogue classification polices help to automatically classify these unknown APs by setting up rules which trigger a rogue AP report when specific-rogue detection criteria are met.
Get this rogue classification policy.
roguePolicyId required | string Rogue classification policy ID. |
tenantId required | string Tenant ID |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "description": "string",
- "rules": [
- {
- "moreInfo": "string",
- "name": "string",
- "type": "AdhocRule",
- "classification": "Ignored",
- "priority": 1
}
], - "id": "string"
}
Update this rogue classification policy.
roguePolicyId required | string Rogue classification policy ID. |
tenantId required | string Tenant ID |
Array of objects (IdAndName) | |
name required | string [ 2 .. 32 ] characters |
description | string [ 0 .. 255 ] characters |
Array of objects (RogueClassificationPolicyRule) |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "description": "string",
- "rules": [
- {
- "moreInfo": "string",
- "name": "string",
- "type": "AdhocRule",
- "classification": "Ignored",
- "priority": 1
}
]
}
{- "requestId": "string",
- "response": {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "description": "string",
- "rules": [
- {
- "moreInfo": "string",
- "name": "string",
- "type": "AdhocRule",
- "classification": "Ignored",
- "priority": 1
}
], - "id": "string"
}
}
Delete this rogue classification policy.
roguePolicyId required | string Rogue classification policy ID. |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": { }
}
Bind a rogue classification policy to a list of venues.
roguePolicyId required | string Rogue classification policy ID. |
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": [
- {
- "venueId": "string",
- "policyId": "string",
- "policyName": "string"
}
]
}
Delete the binding between a rogue classification policy and its list of venues and apply the default classification policy to those venues instead. Note that unbinding a policy from a venue does not disable rogue AP detection in that venue.
roguePolicyId required | string Rogue classification policy ID. |
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get a list of rogue classification policies.
tenantId required | string Tenant ID |
excludeDefault | boolean Default: false |
[- {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "description": "string",
- "rules": [
- {
- "moreInfo": "string",
- "name": "string",
- "type": "AdhocRule",
- "classification": "Ignored",
- "priority": 1
}
], - "id": "string"
}
]
Create a rogue classification policy.
tenantId required | string Tenant ID |
Array of objects (IdAndName) | |
name required | string [ 2 .. 32 ] characters |
description | string [ 0 .. 255 ] characters |
Array of objects (RogueClassificationPolicyRule) |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "description": "string",
- "rules": [
- {
- "moreInfo": "string",
- "name": "string",
- "type": "AdhocRule",
- "classification": "Ignored",
- "priority": 1
}
]
}
{- "requestId": "string",
- "response": {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "name": "string",
- "description": "string",
- "rules": [
- {
- "moreInfo": "string",
- "name": "string",
- "type": "AdhocRule",
- "classification": "Ignored",
- "priority": 1
}
], - "id": "string"
}
}
Delete a list of rogue classification policies.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Manage VLAN pools. A VLAN pool is configured on a wireless network by including its ID in the advanced customization schema object used to create the network or the schema object used to create a network-venue.
When Wi-Fi is deployed in a high density environment such as a stadium or a university campus, the number of IP addresses required for client devices can easily run into the thousands. Placing thousands of clients into a single large subnet or VLAN can result in degraded performance due to factors like broadcast and multicast traffic. VLAN pooling can address this problem. VLAN pooling allows administrators to a deploy pool of multiple VLANs to which clients are assigned, thereby automatically segmenting large groups of clients into multiple smaller subgroups, even when connected to the same SSID. As a client device joins the WLAN, its VLAN is assigned to one of the VLANs in the pool based on a hash of the client’s MAC address.
Use this API command to get the VLAN pool list.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}
]
Use this API command to create a new VLAN pool.
tenantId required | string Tenant ID |
name required | string [ 1 .. 32 ] characters |
description | string [ 0 .. 64 ] characters |
vlanMembers required | Array of strings [ 0 .. 16 ] items |
{- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}
}
Use this API command to delete a VLAN pool list.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Use this API command to get the VLAN pool details.
vlanPoolId required | string VLAN Pool ID |
tenantId required | string Tenant ID |
{- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}
Use this API command to update a VLAN pool.
vlanPoolId required | string VLAN Pool ID |
tenantId required | string Tenant ID |
name required | string [ 1 .. 32 ] characters |
description | string [ 0 .. 64 ] characters |
vlanMembers required | Array of strings [ 0 .. 16 ] items |
{- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "vlanMembers": [
- "string"
], - "id": "string"
}
}
Use this API command to get the VLAN pool list by query.
tenantId required | string Tenant ID |
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "data": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "networksCount": 0,
- "networksNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
Manage client isolation allowlists.
Client isolation features, when enabled, prevent clients residing on a common VLAN from exchanging packets with each other. Client isolation is enforced by APs working at layer 2 (bridging). If client isolation is needed between VLANs/IP subnets, routers must also be configured to prevent packet exchange at layer 3. A client isolation allowlist provides the capability for administrators to configure exceptions to this isolation behavior. For example, an administrator may want to allow clients on a public network to access a printer in a common area of their venue. If so, the MAC and IP addresses of the printer (or any excepted device) can be configured on the client isolation allowlist.
Client isolation can be used in conjunction with walled gardens for public networks. Walled gardens provide limited access to services prior to client authentication whereas client isolation allowlists provide connectivity options post authentication.
Client isolation does not work when clients are assigned static IP addresses. For this reason, Ruckus recommends using DHCP lease reservations in lieu of static IP addresses when using this feature. Administrators may also want to consider use of the force DHCP option, available during wireless network configuration.
Complications to client isolation can arise when the VLAN's default gateway employs VRRP or HSRP for high availability or when Bonjour gateway is configured on the same WLAN as the allowlist. If either of these situations applies in your network, please contact Ruckus customer support for assistance.
Get the client isolation allowlists by query.
tenantId required | string Tenant ID |
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "data": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "clientCount": 0,
- "clientMacs": [
- "string"
], - "networkCount": 0,
- "networkNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
Get the client isolation allowlists.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "tenantId": "string",
- "venueId": "string",
- "name": "string",
- "description": "string",
- "allowlist": [
- {
- "mac": "string",
- "description": "string"
}
], - "id": "string"
}
]
Create a new client isolation allowlist.
tenantId required | string Tenant ID |
venueId required | string |
name required | string [ 2 .. 32 ] characters |
description | string [ 0 .. 64 ] characters |
required | Array of objects (ClientIsolationAllowlistEntry) [ 1 .. 64 ] items |
{- "venueId": "string",
- "name": "string",
- "description": "string",
- "allowlist": [
- {
- "mac": "string",
- "description": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "venueId": "string",
- "name": "string",
- "description": "string",
- "allowlist": [
- {
- "mac": "string",
- "description": "string"
}
], - "id": "string"
}
}
Delete a list of client isolation allowlists.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get the details for this client isolation allowlist.
clientIsolationAllowlistId required | string Client Isolation Allowlist ID |
tenantId required | string Tenant ID |
{- "tenantId": "string",
- "venueId": "string",
- "name": "string",
- "description": "string",
- "allowlist": [
- {
- "mac": "string",
- "description": "string"
}
], - "id": "string"
}
Update this client isolation allowlist.
clientIsolationAllowlistId required | string Client Isolation Allowlist ID |
tenantId required | string Tenant ID |
venueId required | string |
name required | string [ 2 .. 32 ] characters |
description | string [ 0 .. 64 ] characters |
required | Array of objects (ClientIsolationAllowlistEntry) [ 1 .. 64 ] items |
{- "venueId": "string",
- "name": "string",
- "description": "string",
- "allowlist": [
- {
- "mac": "string",
- "description": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "venueId": "string",
- "name": "string",
- "description": "string",
- "allowlist": [
- {
- "mac": "string",
- "description": "string"
}
], - "id": "string"
}
}
Delete this client isolation allowlist.
clientIsolationAllowlistId required | string Client Isolation Allowlist ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": { }
}
Manage Wi-Fi calling profiles. A Wi-Fi calling profile is configured on a wireless network by including its ID in the advanced customization schema object used to create the network.
Get the Wi-Fi calling profiles.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "profileName": "string",
- "description": "string",
- "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
- "id": "string",
- "ePDGs": [
- {
- "ip": "string",
- "domain": "string"
}
]
}
]
Create a new Wi-Fi calling profile.
tenantId required | string Tenant ID |
profileName required | string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
description | string [ 2 .. 180 ] characters |
qosPriority | string Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE" Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG" |
required | Array of objects (Epdg) [ 1 .. 5 ] items |
{- "profileName": "string",
- "description": "string",
- "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
- "ePDGs": [
- {
- "ip": "string",
- "domain": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "profileName": "string",
- "description": "string",
- "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
- "id": "string",
- "ePDGs": [
- {
- "ip": "string",
- "domain": "string"
}
]
}
}
Delete a list of Wi-Fi calling profiles.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get the Wi-Fi calling profile details.
wifiCallingProfileId required | string Wi-Fi calling profile ID |
tenantId required | string Tenant ID |
{- "profileName": "string",
- "description": "string",
- "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
- "id": "string",
- "ePDGs": [
- {
- "ip": "string",
- "domain": "string"
}
]
}
Update a Wi-Fi calling profile.
wifiCallingProfileId required | string Wi-Fi calling profile ID |
tenantId required | string Tenant ID |
profileName required | string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
description | string [ 2 .. 180 ] characters |
qosPriority | string Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE" Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG" |
required | Array of objects (Epdg) [ 1 .. 5 ] items |
{- "profileName": "string",
- "description": "string",
- "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
- "ePDGs": [
- {
- "ip": "string",
- "domain": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "profileName": "string",
- "description": "string",
- "qosPriority": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
- "id": "string",
- "ePDGs": [
- {
- "ip": "string",
- "domain": "string"
}
]
}
}
Delete a Wi-Fi calling profile.
wifiCallingProfileId required | string Wi-Fi calling profile ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": { }
}
Manage vSPoT (virtualized smart positioning technology) servers. A vSPoT server is configured on a venue by using endpoints in the “AP-Venue” API group.
Note that vSPoT servers are configured on venues (as opposed to wireless networks). vSPoT servers estimate the location of all client devices in a venue regardless of the wireless network with which they’re connected.
Get the vSPoT server details.
vspotId required | string vSPoT ID |
tenantId required | string Tenant ID |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "serverName": "string",
- "vspotGlobalId": "string",
- "serverAddress": "string",
- "port": 8883,
- "password": "stringst",
- "id": "string"
}
Update a vSPoT server.
vspotId required | string vSPoT ID |
tenantId required | string Tenant ID |
Array of objects (IdAndName) | |
serverName required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
vspotGlobalId | string |
serverAddress required | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
port | integer <int32> [ 1 .. 65535 ] Default: 8883 |
password required | string [ 8 .. 63 ] characters ^(?!(`|\$))[!-~]{8,63}$ |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "serverName": "string",
- "vspotGlobalId": "string",
- "serverAddress": "string",
- "port": 8883,
- "password": "stringst"
}
{- "requestId": "string",
- "response": {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "serverName": "string",
- "vspotGlobalId": "string",
- "serverAddress": "string",
- "port": 8883,
- "password": "stringst",
- "id": "string"
}
}
Get the vSPoT server list.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "serverName": "string",
- "vspotGlobalId": "string",
- "serverAddress": "string",
- "port": 8883,
- "password": "stringst",
- "id": "string"
}
]
Create a new vSPoT server.
tenantId required | string Tenant ID |
Array of objects (IdAndName) | |
serverName required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
vspotGlobalId | string |
serverAddress required | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
port | integer <int32> [ 1 .. 65535 ] Default: 8883 |
password required | string [ 8 .. 63 ] characters ^(?!(`|\$))[!-~]{8,63}$ |
{- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "serverName": "string",
- "vspotGlobalId": "string",
- "serverAddress": "string",
- "port": 8883,
- "password": "stringst"
}
{- "requestId": "string",
- "response": {
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "serverName": "string",
- "vspotGlobalId": "string",
- "serverAddress": "string",
- "port": 8883,
- "password": "stringst",
- "id": "string"
}
}
Disconnect a list of clients.
tenantId required | string Tenant ID |
clientMac required | string |
apMac required | string |
[- {
- "clientMac": "string",
- "apMac": "string"
}
]
{- "requestId": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "downloadUrl": "string"
}
Get user details for the list of provisioned guest users.
tenantId required | string tenantId |
page | string Default: "1" Page index |
size | string Default: "50" The size of the page to be returned |
{- "content": [
- {
- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}
], - "totalElements": 0
}
Provision one or more guest users as defined in the payload.
tenantId required | string tenantId |
guestsPayload
deliveryMethods required | Array of strings Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one delivery method. |
disabled | boolean If true, this guest user will not be permitted to join the guest network. |
string | |
required | object (GuestUserExpiration) |
maxDevices required | integer <int32> Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced. |
mobilePhoneNumber required | string The mobile phone number associated to the guest user. |
name required | string The name assigned to the guest user. |
networkId required | string Network ID of the guest network. |
notes | string [ 0 .. 180 ] characters |
[- {
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string"
}
]
{- "requestId": "string",
- "response": "string"
}
Delete one or more guest users per their IDs as defined in the payload.
tenantId required | string tenantId |
ids
{- "requestId": "string"
}
Import one or more guest pass users from the payload's CSV file.
tenantId required | string tenantId |
deliveryMethods | Array of strings Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one delivery method. |
expiration.activationType | string Enum: "Creation" "Login" When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration. |
expiration.duration required | integer <int32> [ 1 .. 8760 ] expiration.duration |
expiration.unit required | string Enum: "Minute" "Hour" "Day" "Week" "Month" "Year" "Never" expiration.unit |
maxDevices | integer <int32> Maximum number of devices the guest user can simultaneously connect to the guest network. If set to -1, no limit is enforced. |
networkId | string Network ID of the guest network to which the guest user will connect. |
file required | string <binary> file |
{- "requestId": "string",
- "response": {
- "data": [
- {
- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}
], - "downloadUrl": "string"
}
}
Get a guest user.
guestUserId required | string guestUserId |
tenantId required | string tenantId |
{- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}
Create new password for the guest user. Note: only password hash is saved (not the actual password), so the original password cannot be retrieved.
guestUserId required | string guestUserId |
tenantId required | string tenantId |
At least one delivery method.
[- "MAIL"
]
{- "requestId": "string",
- "response": {
- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}
}
Update the PSK for the recovery network.
tenantId required | string Tenant ID |
psk | string^([0-9]{4}){4}$ |
obsolete | boolean Default: false |
{- "psk": "string",
- "obsolete": false
}
{- "requestId": "string",
- "response": {
- "psk": "string",
- "tenantId": "string",
- "obsolete": false
}
}
View Wi-Fi information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.
Get client (i.e., end-user devices) parameters and operational data.
tenantId required | string tenantId |
apSerialNumber | string apSerialNumber |
page | string page |
size | string size |
[- {
- "apMac": "string",
- "apSerialNumber": "string",
- "connectedSince": "string",
- "healthCheckStatus": "string",
- "hostname": "string",
- "ip": "string",
- "mac": "string",
- "networkId": "string",
- "osType": "string",
- "ssid": "string",
- "switchMac": "string",
- "switchSerialNumber": "string",
- "username": "string",
- "venueId": "string",
- "vlan": 0
}
]
Get extended set of parameters and operational data for the client having this MAC address.
mac required | string mac |
tenantId required | string tenantId |
{- "apMac": "string",
- "apName": "string",
- "apSerialNumber": "string",
- "bssid": "string",
- "connectedSince": "string",
- "healthCheckStatus": "string",
- "hostname": "string",
- "ip": "string",
- "mac": "string",
- "networkId": "string",
- "noiseFloor_dBm": 0,
- "osType": "string",
- "radioChannel": 0,
- "receiveSignalStrength_dBm": 0,
- "rxBytes": 0,
- "rxPackets": 0,
- "snr_dB": 0,
- "ssid": "string",
- "switchMac": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "txBytes": 0,
- "txDropDataPacket": 0,
- "txPackets": 0,
- "username": "string",
- "venueId": "string",
- "venueName": "string",
- "vlan": 0
}
Get guests.
tenantId required | string Tenant ID |
payload
exists | string |
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
mustHaveFields | Array of strings |
mustNotHaveFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "clients": [
- {
- "apMac": "string",
- "apName": "string",
- "bssid": "string",
- "clientMac": "string",
- "connectSince": "string",
- "healthCheckStatus": "string",
- "hostname": "string",
- "ipAddress": "string",
- "networkId": "string",
- "noiseFloor_dBm": 0,
- "osType": "string",
- "radioChannel": 0,
- "receiveSignalStrength_dBm": 0,
- "rxBytes": 0,
- "rxPackets": 0,
- "serialNumber": "string",
- "snr_dB": 0,
- "ssid": "string",
- "switchMac": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "txBytes": 0,
- "txDropDataPacket": 0,
- "txPackets": 0,
- "username": "string",
- "venueId": "string",
- "venueName": "string",
- "vlan": 0
}
], - "creationDate": "string",
- "emailAddress": "string",
- "expiryDate": "string",
- "guestStatus": "string",
- "guestType": "string",
- "id": "string",
- "maxNumberOfClients": 0,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "passDurationHours": 0,
- "socialLogin": true,
- "ssid": "string"
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": [
- "string"
], - "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Get the rogue APs detected in this venue.
tenantId required | string Tenant ID |
venueId required | string Venue ID |
payload
exists | string |
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
mustHaveFields | Array of strings |
mustNotHaveFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "band": "string",
- "category": "string",
- "channel": 0,
- "classificationPolicyName": "string",
- "classificationRuleName": "string",
- "closestAp": {
- "apMac": "string",
- "apName": "string",
- "apSerialNumber": "string",
- "lastUpdTime": "string",
- "snr": 0
}, - "detectingAps": [
- {
- "apMac": "string",
- "apName": "string",
- "apSerialNumber": "string",
- "lastUpdTime": "string",
- "snr": 0
}
], - "lastDetectingAp": {
- "apMac": "string",
- "apName": "string",
- "apSerialNumber": "string",
- "lastUpdTime": "string",
- "snr": 0
}, - "lastUpdTime": "string",
- "locatable": true,
- "numberOfDetectingAps": 0,
- "rogueApMac": "string",
- "rogueMac": "string",
- "ssid": "string"
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": [
- "string"
], - "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Get parameters and operational data for a list of APs.
tenantId required | string Tenant ID |
payload
exists | string |
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
mustHaveFields | Array of strings |
mustNotHaveFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downlink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downMac": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "uplink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": null,
- "band": null,
- "channel": null,
- "operativeChannelBandwidth": null,
- "radioId": null,
- "txPower": null
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "upMac": "string",
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "uplink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downlink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": null,
- "band": null,
- "channel": null,
- "operativeChannelBandwidth": null,
- "radioId": null,
- "txPower": null
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downMac": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "upMac": "string",
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": [
- "string"
], - "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Get parameters and operational data for a list of mesh APs.
tenantId required | string Tenant ID |
payload
exists | string |
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
mustHaveFields | Array of strings |
mustNotHaveFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downlink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downMac": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "uplink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": null,
- "band": null,
- "channel": null,
- "operativeChannelBandwidth": null,
- "radioId": null,
- "txPower": null
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "upMac": "string",
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "uplink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downlink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": null,
- "band": null,
- "channel": null,
- "operativeChannelBandwidth": null,
- "radioId": null,
- "txPower": null
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downMac": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "upMac": "string",
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": [
- "string"
], - "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Get a list of Cloudpath server information.
tenantId required | string Tenant ID |
payload
exists | string |
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
mustHaveFields | Array of strings |
mustNotHaveFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "acctServer": "string",
- "authServer": "string",
- "crtTime": "string",
- "deployedInVenueId": "string",
- "deploymentType": "string",
- "floorplanId": "string",
- "id": "string",
- "lastUpdTime": "string",
- "name": "string",
- "networksCount": 0,
- "sharedSecret": "string",
- "venuesCount": 0,
- "xPercent": 0,
- "yPercent": 0
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": [
- "string"
], - "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Get access control profiles by query.
tenantId required | string Tenant ID |
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
searchTargetFields | Array of strings |
searchString | string |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "sortField": "string",
- "sortOrder": "ASC",
- "searchTargetFields": [
- "string"
], - "searchString": "string"
}
{- "data": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "l2AclPolicyName": "string",
- "l2AclEnable": false,
- "l3AclPolicyName": "string",
- "l3AclEnable": false,
- "devicePolicyName": "string",
- "devicePolicyEnable": false,
- "applicationPolicyName": "string",
- "applicationPolicyEnable": false,
- "urlFilteringPolicyName": "string",
- "urlFilteringPolicyEnable": false,
- "userUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "rateLimitEnable": false,
- "networksCount": 0,
- "networksNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
Get all access control profiles.
tenantId required | string Tenant ID |
[- {
- "devicePolicy": {
- "id": "string",
- "enabled": false
}, - "l2AclPolicy": {
- "id": "string",
- "enabled": false
}, - "l3AclPolicy": {
- "id": "string",
- "enabled": false
}, - "applicationPolicy": {
- "id": "string",
- "enabled": false
}, - "name": "string",
- "description": "string",
- "rateLimiting": {
- "uplinkLimit": 0,
- "downlinkLimit": 0,
- "enabled": false
}, - "id": "string"
}
]
Add an access control profile.
tenantId required | string Tenant ID |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
name required | string [ 2 .. 32 ] characters |
description | string [ 0 .. 64 ] characters |
object (RateLimiting) Client traffic rate limiting |
{- "devicePolicy": {
- "id": "string",
- "enabled": false
}, - "l2AclPolicy": {
- "id": "string",
- "enabled": false
}, - "l3AclPolicy": {
- "id": "string",
- "enabled": false
}, - "applicationPolicy": {
- "id": "string",
- "enabled": false
}, - "name": "string",
- "description": "string",
- "rateLimiting": {
- "uplinkLimit": 0,
- "downlinkLimit": 0,
- "enabled": false
}
}
{- "requestId": "string",
- "response": {
- "devicePolicy": {
- "id": "string",
- "enabled": false
}, - "l2AclPolicy": {
- "id": "string",
- "enabled": false
}, - "l3AclPolicy": {
- "id": "string",
- "enabled": false
}, - "applicationPolicy": {
- "id": "string",
- "enabled": false
}, - "name": "string",
- "description": "string",
- "rateLimiting": {
- "uplinkLimit": 0,
- "downlinkLimit": 0,
- "enabled": false
}, - "id": "string"
}
}
Delete multiple access control profiles by profile identities.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
Get an access control profile by profile identity.
accessControlProfileId required | string Access control profile identity |
tenantId required | string Tenant ID |
{- "devicePolicy": {
- "id": "string",
- "enabled": false
}, - "l2AclPolicy": {
- "id": "string",
- "enabled": false
}, - "l3AclPolicy": {
- "id": "string",
- "enabled": false
}, - "applicationPolicy": {
- "id": "string",
- "enabled": false
}, - "name": "string",
- "description": "string",
- "rateLimiting": {
- "uplinkLimit": 0,
- "downlinkLimit": 0,
- "enabled": false
}, - "id": "string"
}
Update the specified access control profile.
accessControlProfileId required | string Access control profile identity |
tenantId required | string Tenant ID |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
name required | string [ 2 .. 32 ] characters |
description | string [ 0 .. 64 ] characters |
object (RateLimiting) Client traffic rate limiting |
{- "devicePolicy": {
- "id": "string",
- "enabled": false
}, - "l2AclPolicy": {
- "id": "string",
- "enabled": false
}, - "l3AclPolicy": {
- "id": "string",
- "enabled": false
}, - "applicationPolicy": {
- "id": "string",
- "enabled": false
}, - "name": "string",
- "description": "string",
- "rateLimiting": {
- "uplinkLimit": 0,
- "downlinkLimit": 0,
- "enabled": false
}
}
{- "requestId": "string",
- "response": {
- "devicePolicy": {
- "id": "string",
- "enabled": false
}, - "l2AclPolicy": {
- "id": "string",
- "enabled": false
}, - "l3AclPolicy": {
- "id": "string",
- "enabled": false
}, - "applicationPolicy": {
- "id": "string",
- "enabled": false
}, - "name": "string",
- "description": "string",
- "rateLimiting": {
- "uplinkLimit": 0,
- "downlinkLimit": 0,
- "enabled": false
}, - "id": "string"
}
}
Delete the specified access control profile.
accessControlProfileId required | string Access control profile identity |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": { }
}