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-220711.html | Wi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks. |
msp-ns-220711.html | MSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks. |
platform-ns-220711.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-220711.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 |
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) | |
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,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 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) | |
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,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 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) | |
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,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 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",
- "latitude": "string",
- "longitude": "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",
- "latitude": "string",
- "longitude": "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",
- "latitude": "string",
- "longitude": "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",
- "latitude": "string",
- "longitude": "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",
- "latitude": "string",
- "longitude": "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) | |
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,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 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",
- "latitude": "string",
- "longitude": "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",
- "latitude": "string",
- "longitude": "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",
- "latitude": "string",
- "longitude": "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",
- "latitude": "string",
- "longitude": "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",
- "latitude": "string",
- "longitude": "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) | |
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,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 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 the Wi-Fi calling profile details.
wifiCallingProfileId required | string Wi-Fi calling profile ID |
tenantId required | string Tenant ID |
{- "profileName": "string",
- "description": "string",
- "qosPriority": "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": "WIFICALLING_PRI_VOICE",
- "ePDGs": [
- {
- "ip": "string",
- "domain": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "profileName": "string",
- "description": "string",
- "qosPriority": "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": { }
}
Get the Wi-Fi calling profiles.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "profileName": "string",
- "description": "string",
- "qosPriority": "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": "WIFICALLING_PRI_VOICE",
- "ePDGs": [
- {
- "ip": "string",
- "domain": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "profileName": "string",
- "description": "string",
- "qosPriority": "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": { }
}
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
}
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": { }
}
Get the venue syslog settings.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "KEEP_ORIGINAL",
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "flowLevel": "GENERAL_LOGS",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "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": "KEEP_ORIGINAL",
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "flowLevel": "GENERAL_LOGS",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP"
}
{- "requestId": "string",
- "response": {
- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "KEEP_ORIGINAL",
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "flowLevel": "GENERAL_LOGS",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "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": "KEEP_ORIGINAL",
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "flowLevel": "GENERAL_LOGS",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP"
}
}
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 radio.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}
}
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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}
}
{- "requestId": "string",
- "response": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}
}
}
Reset venue radio to default values.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "requestId": "string",
- "response": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}
}
}
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
}
}
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 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"
}
]
}
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 DoS protection of this venue.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "enabled": false,
- "blockingPeriod": 60,
- "failThreshold": 5,
- "checkPeriod": 30
}
Update DoS protection of this venue.
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 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 DHCP service settings of this venue.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic",
- "dhcpServiceProfileIds": [
- "string"
], - "dhcpServiceAps": [
- {
- "serialNumber": "stringstring",
- "role": "PrimaryServer",
- "dhcpIps": [
- "string"
]
}
], - "enableClientIsolationAllowlist": false
}
Update DHCP service settings of this venue.
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 |
Array of objects (DhcpServiceAp) | |
enableClientIsolationAllowlist | boolean Default: false |
{- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic",
- "dhcpServiceProfileIds": [
- "string"
], - "dhcpServiceAps": [
- {
- "serialNumber": "stringstring",
- "role": "PrimaryServer",
- "dhcpIps": [
- "string"
]
}
], - "enableClientIsolationAllowlist": false
}
{- "requestId": "string",
- "response": {
- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic",
- "dhcpServiceProfileIds": [
- "string"
], - "dhcpServiceAps": [
- {
- "serialNumber": "stringstring",
- "role": "PrimaryServer",
- "dhcpIps": [
- "string"
]
}
], - "enableClientIsolationAllowlist": false
}
}
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 the venue radio default values.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}
}
Get a list of DHCP pool usage of the venue.
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 DHCP leases of the venue.
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 the venue Wi-Fi details.
venueId required | string Venue ID |
tenantId required | string Tenant ID |
{- "tenantId": "string",
- "wifiFirmwareVersion": "string",
- "countryCode": "string",
- "apPassword": "string",
- "mesh": {
- "enabled": false
}, - "bandBalancing": {
- "enabled": false,
- "clientPercent24": "string"
}, - "radioCustomization": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}
}, - "denialOfServiceProtection": {
- "enabled": false,
- "blockingPeriod": 60,
- "failThreshold": 5,
- "checkPeriod": 30
}, - "syslog": {
- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "KEEP_ORIGINAL",
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "flowLevel": "GENERAL_LOGS",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP"
}, - "dhcpServiceSetting": {
- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic",
- "dhcpServiceProfileIds": [
- "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"
}
Get the venue list of Wi-Fi details.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "tenantId": "string",
- "wifiFirmwareVersion": "string",
- "countryCode": "string",
- "apPassword": "string",
- "mesh": {
- "enabled": false
}, - "bandBalancing": {
- "enabled": false,
- "clientPercent24": "string"
}, - "radioCustomization": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "scanInterval": 20,
- "txPower": "Auto"
}
}, - "denialOfServiceProtection": {
- "enabled": false,
- "blockingPeriod": 60,
- "failThreshold": 5,
- "checkPeriod": 30
}, - "syslog": {
- "enabled": false,
- "server": "string",
- "port": 514,
- "facility": "KEEP_ORIGINAL",
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "flowLevel": "GENERAL_LOGS",
- "secondaryServer": "string",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP"
}, - "dhcpServiceSetting": {
- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic",
- "dhcpServiceProfileIds": [
- "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"
}
]
Get available LTE bands for each region.
tenantId required | string Tenant ID |
[- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1",
- "countryCodes": [
- "string"
]
}
]
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": { }
}
Get network details, including nested details.
networkId required | string Network ID |
tenantId required | string Tenant ID |
{- "name": "string",
- "id": "string",
- "description": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "id": "string"
}
], - "tenantId": "string",
- "type": "aaa",
- "wlan": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "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)$ |
description | string [ 0 .. 255 ] characters |
Array of objects (NetworkVenue) | |
type required | string |
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",
- "description": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string"
}
], - "tenantId": "string",
- "type": "aaa",
- "wlan": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "enableAuthProxy": false,
- "enableAccountingProxy": false
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "id": "string",
- "description": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "id": "string"
}
], - "tenantId": "string",
- "type": "string",
- "wlan": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "cloudpathServerId": "string",
- "enableAuthProxy": false,
- "enableAccountingProxy": false
}
}
Get the network details.
networkId required | string Network ID |
tenantId required | string Tenant ID |
{- "type": "aaa",
- "wlan": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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 |
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": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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"
}
}
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"
}
Create a new network (deep).
tenantId required | string Tenant ID |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
description | string [ 0 .. 255 ] characters |
Array of objects (NetworkVenue) | |
type required | string |
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",
- "description": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string"
}
], - "tenantId": "string",
- "type": "aaa",
- "wlan": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "enableAuthProxy": false,
- "enableAccountingProxy": false
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "id": "string",
- "description": "string",
- "venues": [
- {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "id": "string"
}
], - "tenantId": "string",
- "type": "string",
- "wlan": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "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": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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 |
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": {
- "wlanSecurity": "WPA2Enterprise",
- "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": "2.4GHZ",
- "bssMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "managementFrameMinimumPhyRate": "1"
}, - "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"
]
}
]
}
}, - "managementFrameProtection": "Disabled",
- "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": [
- {
- "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"
}
], - "name": "string",
- "customExternalProvider": false
}
]
}
Get the DPSK passphrase format list.
tenantId required | string Tenant ID |
[- {
- "dpskPassphraseGeneration": {
- "length": 18,
- "format": "MOST_SECURED",
- "expiration": "UNLIMITED"
}, - "name": "string",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "cloudpathServer": {
- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}, - "id": "string"
}, - "id": "string"
}
]
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": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "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) | |
allApGroupsRadio | string Default: "RadioEnum.Both" Enum: "Both" "2.4-GHz" "5-GHz" |
object (NetworkVenueScheduler) Network-Venue scheduler | |
isAllApGroups | boolean Default: true |
allApGroupsVlanId | integer <int32> [ 1 .. 4094 ] |
vlanPoolId | string |
{- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string"
}
{- "requestId": "string",
- "response": {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "id": "string"
}
}
Create a new network-venue activation.
tenantId required | string Tenant ID |
venueId | string |
networkId | string |
clientIsolationAllowlistId | string |
Array of objects (NetworkApGroup) | |
allApGroupsRadio | string Default: "RadioEnum.Both" Enum: "Both" "2.4-GHz" "5-GHz" |
object (NetworkVenueScheduler) Network-Venue scheduler | |
isAllApGroups | boolean Default: true |
allApGroupsVlanId | integer <int32> [ 1 .. 4094 ] |
vlanPoolId | string |
{- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string"
}
{- "requestId": "string",
- "response": {
- "venueId": "string",
- "networkId": "string",
- "clientIsolationAllowlistId": "string",
- "apGroups": [
- {
- "apGroupId": "string",
- "vlanId": 1,
- "radio": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "id": "string"
}
}
Delete a list of network-venue activation.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
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": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "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": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "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": "Both",
- "isDefault": false,
- "apGroupName": "string",
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationError": false,
- "vlanPoolId": "string",
- "vlanPoolName": "string",
- "id": "string"
}
], - "allApGroupsRadio": "Both",
- "scheduler": {
- "type": "ALWAYS_ON",
- "sun": "string",
- "mon": "string",
- "tue": "string",
- "wed": "string",
- "thu": "string",
- "fri": "string",
- "sat": "string"
}, - "isAllApGroups": true,
- "allApGroupsVlanId": 1,
- "vlanPoolId": "string",
- "id": "string"
}
]
Get layer-3 ACL by profile id.
l3AclPolicyId required | string L3Acl Policy ID |
tenantId required | string Tenant ID |
{- "name": "string",
- "description": "string",
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "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": "ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "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": "ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "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"
}
}
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 profile collection.
tenantId required | string Tenant ID |
[- {
- "name": "string",
- "description": "string",
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "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": "ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "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": "ALLOW",
- "l3Rules": [
- {
- "priority": 1,
- "description": "string",
- "access": "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": { }
}
Get layer-2 ACL by profile id.
l2AclPolicyId required | string L2Acl Policy ID |
tenantId required | string Tenant ID |
{- "name": "string",
- "description": "string",
- "access": "ALLOW",
- "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": "ALLOW",
- "macAddresses": [
- "string"
]
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "description": "string",
- "access": "ALLOW",
- "macAddresses": [
- "string"
], - "id": "string"
}
}
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 profile collection.
tenantId required | string Tenant ID |
[- {
- "name": "string",
- "description": "string",
- "access": "ALLOW",
- "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": "ALLOW",
- "macAddresses": [
- "string"
]
}
{- "requestId": "string",
- "response": {
- "name": "string",
- "description": "string",
- "access": "ALLOW",
- "macAddresses": [
- "string"
], - "id": "string"
}
}
Delete layer-2 ACL profiles.
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": { }
}
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 client isolation allowlists.
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"
}
]
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 device-policy details.
devicePolicyId required | string Device-policy ID |
tenantId required | string Tenant ID |
{- "tenantId": "string",
- "name": "string",
- "description": "string",
- "defaultAccess": "ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "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": "ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "defaultAccess": "ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
], - "id": "string"
}
}
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
}
Get the device-policy collection.
tenantId required | string Tenant ID |
[- {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "defaultAccess": "ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "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": "ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "ALLOW",
- "deviceType": "Laptop",
- "osVendor": "All",
- "downloadRateLimit": 200,
- "uploadRateLimit": 200,
- "vlan": 1
}
]
}
{- "requestId": "string",
- "response": {
- "tenantId": "string",
- "name": "string",
- "description": "string",
- "defaultAccess": "ALLOW",
- "rules": [
- {
- "name": "string",
- "action": "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": { }
}
Update Cloudpath server floor-plan position.
cloudpathServerId required | string Cloudpath Server Id |
tenantId required | string Tenant ID |
floorplanId | string |
yPercent | number <float> [ 0 .. 100 ] Default: 0 |
xPercent | number <float> [ 0 .. 100 ] Default: 0 |
{- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
{- "requestId": "string",
- "response": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
}
Get details for this Cloudpath server.
cloudpathServerId required | string |
tenantId required | string Tenant ID |
{- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 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": "OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
}
{- "requestId": "string",
- "response": {
- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}, - "id": "string"
}
}
Get a list of Cloudpath servers.
tenantId required | string Tenant ID |
page | integer <int32> |
size | integer <int32> |
[- {
- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 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": "OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
}
{- "requestId": "string",
- "response": {
- "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "name": "string",
- "deploymentType": "OnPremise",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "id": "string"
}, - "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}, - "id": "string"
}
}
Delete a list of Cloudpath servers.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
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"
}
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
}
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": { }
}
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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}
{- "requestId": "string",
- "response": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}
}
Update an AP floor-plan position.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
floorplanId | string |
yPercent | number <float> [ 0 .. 100 ] Default: 0 |
xPercent | number <float> [ 0 .. 100 ] Default: 0 |
{- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
{- "requestId": "string",
- "response": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
}
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"
}
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"
}
}
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
}
]
}
}
Get the AP operational and configuration data.
serialNumber required | string The serial number of the AP. |
tenantId required | string Tenant ID |
operational | boolean Default: false Include operational data in response |
{- "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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "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",
- "yPercent": 0,
- "xPercent": 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",
- "yPercent": 0,
- "xPercent": 0
}
}
{- "requestId": "string",
- "response": {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
}
}
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"
}
}
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"
}
}
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 Enum: "RADIO24" "RADIO50" "ETH0" "ETH1" "ETH2" "ETH3" "ETH4" "ETH5" "ETH6" "ETH7" |
macAddressFilter | string^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$|... |
frameTypeFilter | Array of strings Items Enum: "MANAGEMENT" "CONTROL" "DATA" |
{- "captureInterface": "RADIO24",
- "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"
}
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 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 the AP list.
tenantId required | string Tenant ID |
operational | boolean Default: false Include operational data in response |
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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 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",
- "yPercent": 0,
- "xPercent": 0
}
}
]
{- "requestId": "string",
- "response": [
- {
- "serialNumber": "string",
- "apGroupId": "string",
- "venueId": "string",
- "radio": {
- "apRadioParams24G": {
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "allowedChannels": [
- "1"
], - "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
}
]
}
Delete a list of APs.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
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 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"
}
]
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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "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",
- "yPercent": 0,
- "xPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "mac": "null",
- "ip": "null",
- "externalIp": "null",
- "meshRole": "null",
- "uptime_seconds": 0,
- "name": "string",
- "description": "string",
- "tags": [
- "string"
], - "model": "null",
- "position": {
- "floorplanId": "string",
- "yPercent": 0,
- "xPercent": 0
}
}
]
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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "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",
- "yPercent": 0,
- "xPercent": 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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "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",
- "yPercent": 0,
- "xPercent": 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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "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",
- "yPercent": 0,
- "xPercent": 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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "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",
- "yPercent": 0,
- "xPercent": 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 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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "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",
- "yPercent": 0,
- "xPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
], - "isDefault": false,
- "name": "string",
- "description": "string",
- "id": "string"
}
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": "AUTO",
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "operativeTxPower": "string",
- "operativeChannel": 0,
- "snr_dB": 0,
- "method": "MANUAL",
- "changeInterval": 33,
- "txPower": "Auto"
}, - "useVenueSettings": true,
- "enable24G": false,
- "enable50G": false
}, - "clientCount": 0,
- "lastContacted": "null",
- "lastUpdated": "null",
- "indoorModel": false,
- "firmware": "null",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "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",
- "yPercent": 0,
- "xPercent": 0
}, - "updatedDate": "2019-08-24T14:15:22Z"
}
], - "isDefault": false,
- "name": "string",
- "description": "string",
- "id": "string"
}
]
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": { }
}
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": { }
}
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": { }
}
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"
}
]
}
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": { }
}
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": "LIMITED",
- "expirationDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "createdDate": "2019-08-24T14:15:22Z"
}
], - "fields": [
- "string"
], - "totalCount": 0,
- "totalPages": 0,
- "page": 0
}
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": "LIMITED",
- "expirationDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "createdDate": "2019-08-24T14:15:22Z"
}
]
}
}
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"
}
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": "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": "LIMITED",
- "numberOfDevices": 1,
- "username": "string",
- "mac": "string"
}
{- "requestId": "string",
- "response": {
- "networkId": "string",
- "numberOfPassphrases": 1,
- "override": false,
- "passphrase": "stringst",
- "vlanId": 1,
- "numberOfDevicesType": "LIMITED",
- "numberOfDevices": 1,
- "username": "string",
- "mac": "string",
- "id": "string"
}
}
Delete a list of DPSK passphrases.
tenantId required | string Tenant ID |
[- "string"
]
{- "requestId": "string",
- "response": { }
}
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"
}