Wi-Fi API and Model Documentation
Update a list of DPSK passphrases.
Array of objects (SimpleJsonPatch) | |
ids | Array of strings |
updateState | string Enum: "REVOKE" "UNREVOKE" |
{- "dpskPassphrasePatch": [
- {
- "op": "string",
- "path": "string",
- "value": "string"
}
], - "ids": [
- "string"
], - "updateState": "REVOKE"
}
{- "requestId": "string"
}
Create one or more DPSK passphrases.
string [ 0 .. 255 ] characters ^$|^[_a-zA-Z0-9-]+(\.[_a-zA-Z0-9-]+)*@[a-zA-Z... | |
expiration | string |
mac | string^([0-9A-Fa-f]{2}[.:-]){5}([0-9A-Fa-f]{2})$|^(... |
numberOfDevices | integer <int32> [ 1 .. 50 ] Default: 1 |
numberOfDevicesType | string Default: "DpskNumberOfDevicesEnum.LIMITED" Enum: "LIMITED" "UNLIMITED" |
numberOfPassphrases | integer <int32> [ 1 .. 5000 ] Default: 1 |
override | boolean Default: false |
passphrase | string [ 8 .. 63 ] characters ^[ -~]{8,63}$ |
phoneNumber | string [ 0 .. 16 ] characters |
revocationDate | string <date-time> |
revocationReason | string |
username | string [ 0 .. 190 ] characters |
vlanId | integer <int32> [ 1 .. 4094 ] |
{- "email": "string",
- "expiration": "string",
- "mac": "string",
- "numberOfDevices": 1,
- "numberOfDevicesType": "LIMITED",
- "numberOfPassphrases": 1,
- "override": false,
- "passphrase": "stringst",
- "phoneNumber": "string",
- "revocationDate": "2019-08-24T14:15:22Z",
- "revocationReason": "string",
- "username": "string",
- "vlanId": 1
}
{- "requestId": "string"
}
Query for a list of DPSK passphrases.
fields | Array of strings |
object (DpskPassphraseFilters) Filters used to query DPSK passphrase. | |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "filters": {
- "email": [
- "string"
], - "includeExpired": [
- true
], - "mac": [
- "string"
], - "networkId": [
- "string"
], - "passphrase": [
- "string"
], - "phoneNumber": [
- "string"
], - "status": [
- "ACTIVE"
], - "username": [
- "string"
], - "vlanId": [
- 0
]
}, - "page": 1,
- "pageSize": 25,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC"
}
{- "data": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "email": "string",
- "expiration": "string",
- "expirationDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "mac": "string",
- "networkId": "string",
- "networkSsid": "string",
- "numberOfDevices": 1,
- "numberOfDevicesType": "LIMITED",
- "passphrase": "stringst",
- "phoneNumber": "string",
- "revocationDate": "2019-08-24T14:15:22Z",
- "revocationReason": "string",
- "username": "string",
- "vlanId": 1
}
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}
Export all the unexpired DPSK passphrases in the database in a CSV-formatted file.
timezone | string Default: "UTC" |
date-format | string Default: "dd/MM/yyyy HH:mm" |
object (DpskPassphraseFilters) Filters used to query DPSK passphrase. | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
{- "filters": {
- "email": [
- "string"
], - "includeExpired": [
- true
], - "mac": [
- "string"
], - "networkId": [
- "string"
], - "passphrase": [
- "string"
], - "phoneNumber": [
- "string"
], - "status": [
- "ACTIVE"
], - "username": [
- "string"
], - "vlanId": [
- 0
]
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC"
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Create a new Wi-Fi calling profile.
description | string [ 2 .. 180 ] characters |
required | Array of objects (Epdg) [ 1 .. 5 ] items |
profileName required | string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
qosPriority | string Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE" Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG" |
{- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}
{- "requestId": "string"
}
Get the Wi-Fi calling profile details.
wifiCallingProfileId required | string Wi-Fi calling profile ID |
{- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "id": "string",
- "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}
Update a Wi-Fi calling profile.
wifiCallingProfileId required | string Wi-Fi calling profile ID |
description | string [ 2 .. 180 ] characters |
required | Array of objects (Epdg) [ 1 .. 5 ] items |
profileName required | string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
qosPriority | string Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE" Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG" |
{- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}
{- "requestId": "string"
}
Create a new network.
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
type required | string |
object (Radius) Primary and secondary radius servers. | |
accountingRadiusId | string Deprecated |
object (Radius) Primary and secondary radius servers. | |
authRadiusId | string Deprecated |
cloudpathServerId | string |
description | string [ 0 .. 255 ] characters |
enableAccountingProxy | boolean Default: false |
enableAuthProxy | boolean Default: false |
required | object (AAAWlan) WLAN |
{- "name": "string",
- "type": "string",
- "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadiusId": "string",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadiusId": "string",
- "cloudpathServerId": "string",
- "description": "string",
- "enableAccountingProxy": false,
- "enableAuthProxy": false,
- "wlan": {
- "advancedCustomization": {
- "accessControlEnable": false,
- "accessControlProfileId": "string",
- "applicationPolicyEnable": false,
- "applicationPolicyId": "string",
- "arpRequestRateLimit": 15,
- "broadcastProbeResponseDelay": 15,
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "autoVrrp": false,
- "packetsType": "UNICAST"
}, - "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "dhcpRequestRateLimit": 15,
- "directedThreshold": 5,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}, - "dnsProxyEnabled": false,
- "enableAaaVlanOverride": true,
- "enableAirtimeDecongestion": false,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "enableBandBalancing": true,
- "enableDhcpRequestRateLimit": true,
- "enableFastRoaming": false,
- "enableJoinRSSIThreshold": false,
- "enableNeighborReport": true,
- "enableOptimizedConnectivityExperience": false,
- "enableSyslog": false,
- "enableTransientClientManagement": false,
- "forceMobileDeviceDhcp": false,
- "hideSsid": false,
- "joinExpireTime": 300,
- "joinRSSIThreshold": -85,
- "joinWaitThreshold": 10,
- "joinWaitTime": 30,
- "l2AclEnable": false,
- "l2AclPolicyId": "string",
- "l3AclEnable": false,
- "l3AclPolicyId": "string",
- "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "proxyARP": false,
- "radioCustomization": {
- "bssMinimumPhyRate": "1",
- "managementFrameMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "2.4GHZ"
}, - "respectiveAccessControl": true,
- "rssiAssociationRejectionThreshold": -75,
- "singleSessionIdAccounting": false,
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "name": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCNA": false,
- "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "managementFrameProtection": "Disabled",
- "ssid": "string",
- "vlanId": 1,
- "wlanSecurity": "WPA2Enterprise"
}
}
{- "requestId": "string"
}
[- {
- "accountingRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "cloudpathServer": {
- "accountingRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "deploymentType": "OnPremise",
- "id": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}, - "dpskPassphraseGeneration": {
- "expiration": "UNLIMITED",
- "format": "MOST_SECURED",
- "length": 18,
- "policyDefaultAccess": "ACCEPT"
}, - "dpskServiceProfileId": "string",
- "id": "string",
- "name": "string"
}
]
Get the list of external WISPr providers for a captive portal network. Note: these providers have integrated their service with the RUCKUS cloud.
{- "providers": [
- {
- "customExternalProvider": false,
- "name": "string",
- "regions": [
- {
- "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": "string"
}, - "secondary": {
- "ip": "string",
- "port": "string"
}
}, - "authRadius": {
- "primary": {
- "ip": "string",
- "port": "string"
}, - "secondary": {
- "ip": "string",
- "port": "string"
}
}, - "captivePortalUrl": "string",
- "externalProviderUrl": "string",
- "name": "string",
- "redirectUrl": "string",
- "showAnalyticsData": false
}
]
}
]
}
Get the network details.
networkId required | string Network ID |
deep | boolean Default: false Get deep details of this network. |
{- "id": "string",
- "name": "string",
- "type": "AAANetwork",
- "accountingRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadiusId": "string",
- "authRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadiusId": "string",
- "cloudpathServerId": "string",
- "description": "string",
- "enableAccountingProxy": false,
- "enableAuthProxy": false,
- "tenantId": "string",
- "venues": [
- {
- "allApGroupsRadio": "Both",
- "allApGroupsRadioTypes": [
- "2.4-GHz"
], - "allApGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "radioTypes": [
- "2.4-GHz"
], - "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "clientIsolationAllowlistId": "string",
- "dual5gEnabled": false,
- "id": "string",
- "isAllApGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "tripleBandEnabled": false,
- "venueId": "string",
- "vlanPoolId": "string"
}
], - "wlan": {
- "advancedCustomization": {
- "accessControlEnable": false,
- "accessControlProfileId": "string",
- "applicationPolicyEnable": false,
- "applicationPolicyId": "string",
- "arpRequestRateLimit": 15,
- "broadcastProbeResponseDelay": 15,
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "autoVrrp": false,
- "packetsType": "UNICAST"
}, - "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "dhcpRequestRateLimit": 15,
- "directedThreshold": 5,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}, - "dnsProxyEnabled": false,
- "enableAaaVlanOverride": true,
- "enableAirtimeDecongestion": false,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "enableBandBalancing": true,
- "enableDhcpRequestRateLimit": true,
- "enableFastRoaming": false,
- "enableJoinRSSIThreshold": false,
- "enableNeighborReport": true,
- "enableOptimizedConnectivityExperience": false,
- "enableSyslog": false,
- "enableTransientClientManagement": false,
- "forceMobileDeviceDhcp": false,
- "hideSsid": false,
- "joinExpireTime": 300,
- "joinRSSIThreshold": -85,
- "joinWaitThreshold": 10,
- "joinWaitTime": 30,
- "l2AclEnable": false,
- "l2AclPolicyId": "string",
- "l3AclEnable": false,
- "l3AclPolicyId": "string",
- "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "proxyARP": false,
- "radioCustomization": {
- "bssMinimumPhyRate": "1",
- "managementFrameMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "2.4GHZ"
}, - "respectiveAccessControl": true,
- "rssiAssociationRejectionThreshold": -75,
- "singleSessionIdAccounting": false,
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCNA": false,
- "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "managementFrameProtection": "Disabled",
- "ssid": "string",
- "vlanId": 1,
- "wlanSecurity": "WPA2Enterprise"
}
}
Update this network, including nested details.
networkId required | string Network ID |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
type required | string |
object (Radius) Primary and secondary radius servers. | |
accountingRadiusId | string Deprecated |
object (Radius) Primary and secondary radius servers. | |
authRadiusId | string Deprecated |
cloudpathServerId | string |
description | string [ 0 .. 255 ] characters |
enableAccountingProxy | boolean Default: false |
enableAuthProxy | boolean Default: false |
required | object (AAAWlan) WLAN |
{- "name": "string",
- "type": "string",
- "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadiusId": "string",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadiusId": "string",
- "cloudpathServerId": "string",
- "description": "string",
- "enableAccountingProxy": false,
- "enableAuthProxy": false,
- "wlan": {
- "advancedCustomization": {
- "accessControlEnable": false,
- "accessControlProfileId": "string",
- "applicationPolicyEnable": false,
- "applicationPolicyId": "string",
- "arpRequestRateLimit": 15,
- "broadcastProbeResponseDelay": 15,
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientIsolationOptions": {
- "autoVrrp": false,
- "packetsType": "UNICAST"
}, - "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "dhcpRequestRateLimit": 15,
- "directedThreshold": 5,
- "dnsProxy": {
- "dnsProxyRules": [
- {
- "domainName": "string",
- "ipList": [
- "string"
]
}
]
}, - "dnsProxyEnabled": false,
- "enableAaaVlanOverride": true,
- "enableAirtimeDecongestion": false,
- "enableAntiSpoofing": false,
- "enableArpRequestRateLimit": true,
- "enableBandBalancing": true,
- "enableDhcpRequestRateLimit": true,
- "enableFastRoaming": false,
- "enableJoinRSSIThreshold": false,
- "enableNeighborReport": true,
- "enableOptimizedConnectivityExperience": false,
- "enableSyslog": false,
- "enableTransientClientManagement": false,
- "forceMobileDeviceDhcp": false,
- "hideSsid": false,
- "joinExpireTime": 300,
- "joinRSSIThreshold": -85,
- "joinWaitThreshold": 10,
- "joinWaitTime": 30,
- "l2AclEnable": false,
- "l2AclPolicyId": "string",
- "l3AclEnable": false,
- "l3AclPolicyId": "string",
- "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "proxyARP": false,
- "radioCustomization": {
- "bssMinimumPhyRate": "1",
- "managementFrameMinimumPhyRate": "1",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "2.4GHZ"
}, - "respectiveAccessControl": true,
- "rssiAssociationRejectionThreshold": -75,
- "singleSessionIdAccounting": false,
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "name": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCNA": false,
- "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "managementFrameProtection": "Disabled",
- "ssid": "string",
- "vlanId": 1,
- "wlanSecurity": "WPA2Enterprise"
}
}
{- "requestId": "string"
}
Validate the x509 certificate chain issued by a trusted certificate authority.
info | string |
Array of objects (X509Certificate) | |
required | object (X509Certificate) X509 certificate |
{- "info": "string",
- "interCerts": [
- {
- "certData": "string",
- "fileName": "string",
- "isRootCert": false
}
], - "rootCert": {
- "certData": "string",
- "fileName": "string",
- "isRootCert": false
}
}
{- "requestId": "string"
}
Unbind a DHCP service-profile from venues.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
[- "string"
]
{- "requestId": "string"
}
Bind a DHCP service-profile with venues.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
[- "string"
]
{- "requestId": "string"
}
Get the venue DHCP service profiles.
venueId required | string Venue ID |
[- {
- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
]
Update the venue DHCP service profile bound to venue.
venueId required | string Venue ID |
[- "string"
]
{- "requestId": "string"
}
[- {
- "accountingRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "deploymentType": "OnPremise",
- "id": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
]
Add a new Cloudpath server.
object (Radius) Primary and secondary radius servers. | |
required | object (Radius) Primary and secondary radius servers. |
deployedInVenueId | string |
deployedInVenueName | string |
deploymentType | string Default: "CloudpathDeploymentTypeEnum.OnPremise" Enum: "OnPremise" "Cloud" |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
object (ApPosition) AP position object |
{- "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "deploymentType": "OnPremise",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
{- "requestId": "string"
}
Get details for this Cloudpath server.
cloudpathServerId required | string |
{- "accountingRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "deploymentType": "OnPremise",
- "id": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
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 |
action required | string Value: "testConnection" |
{- "action": "testConnection"
}
{- "requestId": "string"
}
Update the configuration of this Cloudpath server.
cloudpathServerId required | string |
object (Radius) Primary and secondary radius servers. | |
required | object (Radius) Primary and secondary radius servers. |
deployedInVenueId | string |
deployedInVenueName | string |
deploymentType | string Default: "CloudpathDeploymentTypeEnum.OnPremise" Enum: "OnPremise" "Cloud" |
name required | string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
object (ApPosition) AP position object |
{- "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "deployedInVenueId": "string",
- "deployedInVenueName": "string",
- "deploymentType": "OnPremise",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
{- "requestId": "string"
}
Update Cloudpath server floor-plan position.
cloudpathServerId required | string Cloudpath Server Id |
floorplanId | string |
xPercent | number <float> [ 0 .. 100 ] Default: 0 |
yPercent | number <float> [ 0 .. 100 ] Default: 0 |
{- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
{- "requestId": "string"
}
Add layer-2 ACL by profile.
access | string Default: "AccessEnum.BLOCK" Enum: "ALLOW" "BLOCK" |
description | string |
macAddresses required | Array of strings [ 1 .. 128 ] items |
name required | string [ 2 .. 32 ] characters |
{- "access": "ALLOW",
- "description": "string",
- "macAddresses": [
- "string"
], - "name": "string"
}
{- "requestId": "string"
}
Query layer-2 ACL profile.
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC"
}
{- "data": [
- {
- "description": "string",
- "id": "string",
- "macAddressesCount": 0,
- "name": "string",
- "networksCount": 0,
- "networksNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}
Update layer-2 ACL by profile id.
l2AclPolicyId required | string L2Acl Policy ID |
access | string Default: "AccessEnum.BLOCK" Enum: "ALLOW" "BLOCK" |
description | string |
macAddresses required | Array of strings [ 1 .. 128 ] items |
name required | string [ 2 .. 32 ] characters |
{- "access": "ALLOW",
- "description": "string",
- "macAddresses": [
- "string"
], - "name": "string"
}
{- "requestId": "string"
}
[- {
- "defaultAccess": "ALLOW",
- "description": "string",
- "id": "string",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "id": "string",
- "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
], - "name": "string"
}
]
Add layer-3 ACL by profile.
defaultAccess | string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK" |
description | string |
Array of objects (L3Rule) [ 1 .. 128 ] items | |
name required | string [ 2 .. 32 ] characters |
{- "defaultAccess": "ALLOW",
- "description": "string",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
], - "name": "string"
}
{- "requestId": "string"
}
Query layer-3 ACL profile.
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC"
}
{- "data": [
- {
- "description": "string",
- "id": "string",
- "name": "string",
- "networksCount": 0,
- "networksNames": [
- "string"
], - "rulesCount": 0
}
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}
Get layer-3 ACL by profile id.
l3AclPolicyId required | string L3Acl Policy ID |
{- "defaultAccess": "ALLOW",
- "description": "string",
- "id": "string",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "id": "string",
- "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
], - "name": "string"
}
Update layer-3 ACL by profile id.
l3AclPolicyId required | string L3Acl Policy ID |
defaultAccess | string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK" |
description | string |
Array of objects (L3Rule) [ 1 .. 128 ] items | |
name required | string [ 2 .. 32 ] characters |
{- "defaultAccess": "ALLOW",
- "description": "string",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
], - "name": "string"
}
{- "requestId": "string"
}
Manage client isolation allowlists.
Client isolation features, when enabled, prevent clients residing on a common VLAN from exchanging packets with each other. Client isolation is enforced by APs working at layer 2 (bridging). If client isolation is needed between VLANs/IP subnets, routers must also be configured to prevent packet exchange at layer 3. A client isolation allowlist provides the capability for administrators to configure exceptions to this isolation behavior. For example, an administrator may want to allow clients on a public network to access a printer in a common area of their venue. If so, the MAC and IP addresses of the printer (or any excepted device) can be configured on the client isolation allowlist.
Client isolation can be used in conjunction with walled gardens for public networks. Walled gardens provide limited access to services prior to client authentication whereas client isolation allowlists provide connectivity options post authentication.
Client isolation does not work when clients are assigned static IP addresses. For this reason, Ruckus recommends using DHCP lease reservations in lieu of static IP addresses when using this feature. Administrators may also want to consider use of the force DHCP option, available during wireless network configuration.
Complications to client isolation can arise when the VLAN's default gateway employs VRRP or HSRP for high availability or when Bonjour gateway is configured on the same WLAN as the allowlist. If either of these situations applies in your network, please contact Ruckus customer support for assistance.
[- {
- "allowlist": [
- {
- "description": "string",
- "mac": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "venueId": "string"
}
]
Create a new client isolation allowlist.
required | Array of objects (ClientIsolationAllowlistEntry) [ 1 .. 64 ] items |
description | string [ 0 .. 64 ] characters |
name required | string [ 2 .. 32 ] characters |
venueId | string Required before new UI. |
{- "allowlist": [
- {
- "description": "string",
- "mac": "string"
}
], - "description": "string",
- "name": "string",
- "venueId": "string"
}
{- "requestId": "string"
}
Get the details for this client isolation allowlist.
clientIsolationAllowlistId required | string Client Isolation Allowlist ID |
{- "allowlist": [
- {
- "description": "string",
- "mac": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "venueId": "string"
}
Update this client isolation allowlist.
clientIsolationAllowlistId required | string Client Isolation Allowlist ID |
required | Array of objects (ClientIsolationAllowlistEntry) [ 1 .. 64 ] items |
description | string [ 0 .. 64 ] characters |
name required | string [ 2 .. 32 ] characters |
venueId | string Required before new UI. |
{- "allowlist": [
- {
- "description": "string",
- "mac": "string"
}
], - "description": "string",
- "name": "string",
- "venueId": "string"
}
{- "requestId": "string"
}
[- {
- "defaultAccess": "ALLOW",
- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 200,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 200,
- "vlan": 1
}
], - "tenantId": "string"
}
]
Create a new device-policy.
defaultAccess | string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK" |
description | string [ 2 .. 180 ] characters |
name required | string [ 2 .. 32 ] characters |
Array of objects (DevicePolicyRule) [ 1 .. 32 ] items |
{- "defaultAccess": "ALLOW",
- "description": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 200,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 200,
- "vlan": 1
}
]
}
{- "requestId": "string"
}
Get the device-policy list.
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC"
}
{- "data": [
- {
- "description": "string",
- "id": "string",
- "name": "string",
- "networksCount": 0,
- "networksNames": [
- "string"
], - "rulesCount": 0
}
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}
Get the device-policy details.
devicePolicyId required | string Device-policy ID |
{- "defaultAccess": "ALLOW",
- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 200,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 200,
- "vlan": 1
}
], - "tenantId": "string"
}
Update a device-policy.
devicePolicyId required | string Device-policy ID |
defaultAccess | string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK" |
description | string [ 2 .. 180 ] characters |
name required | string [ 2 .. 32 ] characters |
Array of objects (DevicePolicyRule) [ 1 .. 32 ] items |
{- "defaultAccess": "ALLOW",
- "description": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 200,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 200,
- "vlan": 1
}
]
}
{- "requestId": "string"
}
[- {
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "GENERAL_LOGS",
- "id": "string",
- "name": "string",
- "primary": {
- "port": 514,
- "protocol": "TCP",
- "server": "string"
}, - "priority": "EMERGENCY",
- "secondary": {
- "port": 514,
- "protocol": "TCP",
- "server": "string"
}, - "venues": [
- {
- "id": "string",
- "name": "string"
}
]
}
]
Create a new syslog server profile.
facility | string Default: "FacilityEnum.KEEP_ORIGINAL" Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7" |
flowLevel | string Default: "FlowLevelEnum.CLIENT_FLOW" Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL" |
name required | string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$ |
required | object (SyslogServer) Syslog server |
priority | string Default: "PriorityEnum.INFO" Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL" |
object (SyslogServer) Syslog server | |
Array of objects (IdAndName) |
{- "facility": "KEEP_ORIGINAL",
- "flowLevel": "GENERAL_LOGS",
- "name": "string",
- "primary": {
- "port": 514,
- "protocol": "TCP",
- "server": "string"
}, - "priority": "EMERGENCY",
- "secondary": {
- "port": 514,
- "protocol": "TCP",
- "server": "string"
}, - "venues": [
- {
- "id": "string",
- "name": "string"
}
]
}
{- "requestId": "string"
}
Get the syslog server profile details.
syslogServerProfileId required | string Syslog Server Profile ID |
{- "facility": "KEEP_ORIGINAL",
- "flowLevel": "GENERAL_LOGS",
- "id": "string",
- "name": "string",
- "primary": {
- "port": 514,
- "protocol": "TCP",
- "server": "string"
}, - "priority": "EMERGENCY",
- "secondary": {
- "port": 514,
- "protocol": "TCP",
- "server": "string"
}, - "venues": [
- {
- "id": "string",
- "name": "string"
}
]
}
Update a syslog server profile.
syslogServerProfileId required | string Syslog Server Profile ID |
facility | string Default: "FacilityEnum.KEEP_ORIGINAL" Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7" |
flowLevel | string Default: "FlowLevelEnum.CLIENT_FLOW" Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL" |
name required | string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$ |
required | object (SyslogServer) Syslog server |
priority | string Default: "PriorityEnum.INFO" Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL" |
object (SyslogServer) Syslog server | |
Array of objects (IdAndName) |
{- "facility": "KEEP_ORIGINAL",
- "flowLevel": "GENERAL_LOGS",
- "name": "string",
- "primary": {
- "port": 514,
- "protocol": "TCP",
- "server": "string"
}, - "priority": "EMERGENCY",
- "secondary": {
- "port": 514,
- "protocol": "TCP",
- "server": "string"
}, - "venues": [
- {
- "id": "string",
- "name": "string"
}
]
}
{- "requestId": "string"
}
Delete multiple access control profiles by profile identities.
[- "string"
]
{- "requestId": "string"
}
[- {
- "applicationPolicy": {
- "enabled": false,
- "id": "string"
}, - "description": "string",
- "devicePolicy": {
- "enabled": false,
- "id": "string"
}, - "id": "string",
- "l2AclPolicy": {
- "enabled": false,
- "id": "string"
}, - "l3AclPolicy": {
- "enabled": false,
- "id": "string"
}, - "name": "string",
- "rateLimiting": {
- "downlinkLimit": 0,
- "enabled": false,
- "uplinkLimit": 0
}
}
]
Add an access control profile.
object (IdAndEnabled) Profile ID and enabled | |
description | string [ 0 .. 64 ] characters |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
name required | string [ 2 .. 32 ] characters |
object (RateLimiting) Client traffic rate limiting |
{- "applicationPolicy": {
- "enabled": false,
- "id": "string"
}, - "description": "string",
- "devicePolicy": {
- "enabled": false,
- "id": "string"
}, - "l2AclPolicy": {
- "enabled": false,
- "id": "string"
}, - "l3AclPolicy": {
- "enabled": false,
- "id": "string"
}, - "name": "string",
- "rateLimiting": {
- "downlinkLimit": 0,
- "enabled": false,
- "uplinkLimit": 0
}
}
{- "requestId": "string"
}
Get access control profiles by query.
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC"
}
{- "data": [
- {
- "applicationPolicyEnable": false,
- "applicationPolicyName": "string",
- "description": "string",
- "devicePolicyEnable": false,
- "devicePolicyName": "string",
- "id": "string",
- "l2AclEnable": false,
- "l2AclPolicyName": "string",
- "l3AclEnable": false,
- "l3AclPolicyName": "string",
- "name": "string",
- "networksCount": 0,
- "networksNames": [
- "string"
], - "rateLimitEnable": false,
- "urlFilteringPolicyEnable": false,
- "urlFilteringPolicyName": "string",
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0
}
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}
Get an access control profile by profile identity.
accessControlProfileId required | string Access control profile identity |
{- "applicationPolicy": {
- "enabled": false,
- "id": "string"
}, - "description": "string",
- "devicePolicy": {
- "enabled": false,
- "id": "string"
}, - "id": "string",
- "l2AclPolicy": {
- "enabled": false,
- "id": "string"
}, - "l3AclPolicy": {
- "enabled": false,
- "id": "string"
}, - "name": "string",
- "rateLimiting": {
- "downlinkLimit": 0,
- "enabled": false,
- "uplinkLimit": 0
}
}
Update the specified access control profile.
accessControlProfileId required | string Access control profile identity |
object (IdAndEnabled) Profile ID and enabled | |
description | string [ 0 .. 64 ] characters |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
object (IdAndEnabled) Profile ID and enabled | |
name required | string [ 2 .. 32 ] characters |
object (RateLimiting) Client traffic rate limiting |
{- "applicationPolicy": {
- "enabled": false,
- "id": "string"
}, - "description": "string",
- "devicePolicy": {
- "enabled": false,
- "id": "string"
}, - "l2AclPolicy": {
- "enabled": false,
- "id": "string"
}, - "l3AclPolicy": {
- "enabled": false,
- "id": "string"
}, - "name": "string",
- "rateLimiting": {
- "downlinkLimit": 0,
- "enabled": false,
- "uplinkLimit": 0
}
}
{- "requestId": "string"
}
Use this API command to create a new VLAN pool.
description | string [ 0 .. 64 ] characters |
name required | string [ 1 .. 32 ] characters |
vlanMembers required | Array of strings [ 0 .. 16 ] items |
{- "description": "string",
- "name": "string",
- "vlanMembers": [
- "string"
]
}
{- "requestId": "string"
}
Use this API command to get the VLAN pool list by query.
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC"
}
{- "data": [
- {
- "description": "string",
- "id": "string",
- "name": "string",
- "networksCount": 0,
- "networksNames": [
- "string"
]
}
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}
Use this API command to get the VLAN pool details.
vlanPoolId required | string VLAN Pool ID |
{- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}
Use this API command to partial update a VLAN pool.
vlanPoolId required | string VLAN Pool ID |
description | string [ 0 .. 64 ] characters |
name | string [ 1 .. 32 ] characters |
vlanMembers | Array of strings [ 0 .. 16 ] items |
{- "description": "string",
- "name": "string",
- "vlanMembers": [
- "string"
]
}
{- "requestId": "string"
}
Use this API command to update a VLAN pool.
vlanPoolId required | string VLAN Pool ID |
description | string [ 0 .. 64 ] characters |
name required | string [ 1 .. 32 ] characters |
vlanMembers required | Array of strings [ 0 .. 16 ] items |
{- "description": "string",
- "name": "string",
- "vlanMembers": [
- "string"
]
}
{- "requestId": "string"
}
Use this API command to delete an application policy list.
[- "string"
]
{- "requestId": "string"
}
[- {
- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "accessControl": "DENY",
- "applicationId": 0,
- "applicationName": "string",
- "category": "string",
- "categoryId": 0,
- "destinationIp": "string",
- "destinationPort": 1,
- "downLinkMarkingType": "VOICE",
- "downlink": 250,
- "id": "string",
- "markingPriority": "IEEE802_1P",
- "name": "string",
- "netmask": "string",
- "portMapping": "IP_WITH_PORT",
- "priority": 0,
- "protocol": "TCP",
- "ruleType": "SIGNATURE",
- "upLinkMarkingType": "VOICE",
- "uplink": 250
}
], - "tenantId": "string"
}
]
Use this API command to create a new application policy.
description | string [ 0 .. 64 ] characters |
name required | string [ 2 .. 32 ] characters |
Array of objects (ApplicationPolicyRule) [ 1 .. 128 ] items |
{- "description": "string",
- "name": "string",
- "rules": [
- {
- "accessControl": "DENY",
- "applicationId": 0,
- "applicationName": "string",
- "category": "string",
- "categoryId": 0,
- "destinationIp": "string",
- "destinationPort": 1,
- "downLinkMarkingType": "VOICE",
- "downlink": 250,
- "markingPriority": "IEEE802_1P",
- "name": "string",
- "netmask": "string",
- "portMapping": "IP_WITH_PORT",
- "priority": 0,
- "protocol": "TCP",
- "ruleType": "SIGNATURE",
- "upLinkMarkingType": "VOICE",
- "uplink": 250
}
]
}
{- "requestId": "string"
}
Use this API command to get the application policy list by query.
fields | Array of strings |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "page": 1,
- "pageSize": 25,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC"
}
{- "data": [
- {
- "description": "string",
- "id": "string",
- "name": "string",
- "networksCount": 0,
- "networksNames": [
- "string"
], - "rulesCount": 0
}
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}
Use this API command to get the application policy details.
applicationPolicyId required | string |
{- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "accessControl": "DENY",
- "applicationId": 0,
- "applicationName": "string",
- "category": "string",
- "categoryId": 0,
- "destinationIp": "string",
- "destinationPort": 1,
- "downLinkMarkingType": "VOICE",
- "downlink": 250,
- "id": "string",
- "markingPriority": "IEEE802_1P",
- "name": "string",
- "netmask": "string",
- "portMapping": "IP_WITH_PORT",
- "priority": 0,
- "protocol": "TCP",
- "ruleType": "SIGNATURE",
- "upLinkMarkingType": "VOICE",
- "uplink": 250
}
], - "tenantId": "string"
}
Use this API command to update application policy.
applicationPolicyId required | string |
description | string [ 0 .. 64 ] characters |
name required | string [ 2 .. 32 ] characters |
Array of objects (ApplicationPolicyRule) [ 1 .. 128 ] items |
{- "description": "string",
- "name": "string",
- "rules": [
- {
- "accessControl": "DENY",
- "applicationId": 0,
- "applicationName": "string",
- "category": "string",
- "categoryId": 0,
- "destinationIp": "string",
- "destinationPort": 1,
- "downLinkMarkingType": "VOICE",
- "downlink": 250,
- "markingPriority": "IEEE802_1P",
- "name": "string",
- "netmask": "string",
- "portMapping": "IP_WITH_PORT",
- "priority": 0,
- "protocol": "TCP",
- "ruleType": "SIGNATURE",
- "upLinkMarkingType": "VOICE",
- "uplink": 250
}
]
}
{- "requestId": "string"
}
Manage APs including pinging, trace-routing, resetting, rebooting, floor-plan positioning, Bonjour gateway and LAN-Ports settings.
Get the APs in the AP-group.
apGroupId required | string AP-group ID |
[- {
- "apGroupId": "string",
- "clientCount": 0,
- "description": "string",
- "deviceGps": {
- "latitude": "string",
- "longitude": "string"
}, - "externalIp": "null",
- "firmware": "null",
- "indoorModel": false,
- "ip": "null",
- "lastContacted": "null",
- "lastUpdated": "null",
- "mac": "null",
- "meshRole": "null",
- "model": "null",
- "name": "string",
- "networkSettings": {
- "gateway": "string",
- "ip": "string",
- "ipType": "DYNAMIC",
- "netmask": "string",
- "primaryDnsServer": "string",
- "secondaryDnsServer": "string"
}, - "poePortStatus": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParamsDual5G": {
- "enabled": true,
- "lower5gEnabled": false,
- "radioParamsLower5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "upper5gEnabled": false
}, - "enable24G": false,
- "enable50G": false,
- "enable6G": false,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
]
Get the AP list.
operational | boolean Default: false Include operational data in response |
[- {
- "apGroupId": "string",
- "clientCount": 0,
- "description": "string",
- "deviceGps": {
- "latitude": "string",
- "longitude": "string"
}, - "externalIp": "null",
- "firmware": "null",
- "indoorModel": false,
- "ip": "null",
- "lastContacted": "null",
- "lastUpdated": "null",
- "mac": "null",
- "meshRole": "null",
- "model": "null",
- "name": "string",
- "networkSettings": {
- "gateway": "string",
- "ip": "string",
- "ipType": "DYNAMIC",
- "netmask": "string",
- "primaryDnsServer": "string",
- "secondaryDnsServer": "string"
}, - "poePortStatus": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParamsDual5G": {
- "enabled": true,
- "lower5gEnabled": false,
- "radioParamsLower5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "upper5gEnabled": false
}, - "enable24G": false,
- "enable50G": false,
- "enable6G": false,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
]
Add a list of new APs.
apGroupId | string |
description | string [ 0 .. 180 ] characters |
object (DeviceGps) Ap or Venue latitude and longitude | |
model | string [ 0 .. 64 ] characters Default: "null" |
name required | string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$ |
object (ApPosition) AP position object | |
serialNumber required | string^[1-9][0-9]{11}$ |
tags | Array of strings [ 0 .. 24 ] items |
venueId required | string |
[- {
- "apGroupId": "string",
- "description": "string",
- "deviceGps": {
- "latitude": "string",
- "longitude": "string"
}, - "model": "null",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "serialNumber": "string",
- "tags": [
- "string"
], - "venueId": "string"
}
]
{- "requestId": "string"
}
Get the AP operational and configuration data.
serialNumber required | string The serial number of the AP. |
operational | boolean Default: false Include operational data in response |
{- "apGroupId": "string",
- "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "deviceGps": {
- "latitude": "string",
- "longitude": "string"
}, - "externalIp": "null",
- "firmware": "null",
- "indoorModel": false,
- "ip": "null",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": false,
- "useVenueSettings": false
}, - "lastContacted": "null",
- "lastUpdated": "null",
- "mac": "null",
- "meshRole": "null",
- "model": "null",
- "name": "string",
- "poePortStatus": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParamsDual5G": {
- "enabled": true,
- "lower5gEnabled": false,
- "radioParamsLower5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "upper5gEnabled": false
}, - "enable24G": false,
- "enable50G": false,
- "enable6G": false,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
Trigger AP action.
serialNumber required | string The serial number of the AP. |
action required | string Enum: "ping" "traceRoute" "reboot" "factoryReset" "blinkLed" |
targetHost | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
{- "action": "ping",
- "targetHost": "string"
}
{- "requestId": "string"
}
Update an AP.
serialNumber required | string The serial number of the AP. |
apGroupId | string |
description | string [ 0 .. 180 ] characters |
object (DeviceGps) Ap or Venue latitude and longitude | |
model | string [ 0 .. 64 ] characters Default: "null" |
name required | string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$ |
object (ApPosition) AP position object | |
serialNumber required | string^[1-9][0-9]{11}$ |
tags | Array of strings [ 0 .. 24 ] items |
venueId required | string |
{- "apGroupId": "string",
- "description": "string",
- "deviceGps": {
- "latitude": "string",
- "longitude": "string"
}, - "model": "null",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "serialNumber": "string",
- "tags": [
- "string"
], - "venueId": "string"
}
{- "requestId": "string"
}
serialNumber required | string The serial number of the AP. |
{- "apModels": [
- {
- "allowCbandCountry": [
- "string"
], - "allowDfsCountry": [
- "string"
], - "canSupportCellular": false,
- "canSupportLacp": false,
- "canSupportPoeMode": false,
- "canSupportPoeOut": false,
- "capabilityScore": 0,
- "externalAntenna": {
- "coupled": false,
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "supportDisable": false
}, - "has160MHzChannelBandwidth": false,
- "isOutdoor": false,
- "lanPortPictureDownloadUrl": "string",
- "lanPorts": [
- {
- "defaultType": "string",
- "displayLabel": "string",
- "id": "string",
- "isPoeOutPort": false,
- "isPoePort": false,
- "supportDisable": false,
- "trunkPortOnly": false,
- "untagId": 0,
- "vlanMembers": "string"
}
], - "ledOn": false,
- "lldpAdInterval": 0,
- "lldpEnable": false,
- "lldpHoldTime": 0,
- "lldpMgmtEnable": false,
- "maxChannelization24G": 0,
- "maxChannelization5G": 0,
- "maxChannelization6G": 0,
- "model": "string",
- "pictureDownloadUrl": "string",
- "poeModeCapabilities": [
- "string"
], - "primaryWanRecoveryTimer": 0,
- "requireOneEnabledTrunkPort": false,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "string",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "string",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "support11AX": false,
- "supportChannel144": false,
- "supportDual5gMode": false,
- "supportTriRadio": false,
- "version": "string",
- "wanConnection": "string"
}
]
}
Get AP default regulatory channels.
serialNumber required | string AP serialNumber |
{- "2.4GChannels": {
- "20MHz": [
- "1"
], - "40MHz": [
- "1"
], - "auto": [
- "1"
]
}, - "5GChannels": {
- "dfs": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoorForOutdoorAp": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "outdoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}
}, - "5GLowerChannels": {
- "dfs": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoorForOutdoorAp": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "outdoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}
}, - "5GUpperChannels": {
- "dfs": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoorForOutdoorAp": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "outdoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}
}, - "6GChannels": {
- "160MHz": [
- "1"
], - "20MHz": [
- "1"
], - "40MHz": [
- "1"
], - "80MHz": [
- "1"
], - "auto": [
- "1"
]
}
}
Get DHCP lease time collections.
serialNumber required | string The serial number of the AP. |
[- {
- "dhcpProfileId": "string",
- "dhcpProfileName": "string",
- "hostname": "string",
- "ipAddress": "string",
- "leaseExpiration": "string",
- "macAddress": "string",
- "status": "string"
}
]
Get DHCP pool usage.
serialNumber required | string The serial number of the AP. |
[- {
- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "totalIpCount": 0,
- "usedIpCount": 0,
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
]
Get directed multicast settings for this AP.
serialNumber required | string The serial number of the AP. |
{- "networkEnabled": false,
- "useVenueSettings": true,
- "wiredEnabled": false,
- "wirelessEnabled": false
}
Update directed multicast settings of this AP.
serialNumber required | string The serial number of the AP. |
networkEnabled | boolean Default: false |
useVenueSettings | boolean Default: true |
wiredEnabled | boolean Default: false |
wirelessEnabled | boolean Default: false |
{- "networkEnabled": false,
- "useVenueSettings": true,
- "wiredEnabled": false,
- "wirelessEnabled": false
}
{- "requestId": "string"
}
Update an AP floor-plan position.
serialNumber required | string The serial number of the AP. |
floorplanId | string |
xPercent | number <float> [ 0 .. 100 ] Default: 0 |
yPercent | number <float> [ 0 .. 100 ] Default: 0 |
{- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
{- "requestId": "string"
}
Get AP LAN-ports details.
serialNumber required | string The serial number of the AP. |
{- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": false,
- "useVenueSettings": false
}
Update LAN-ports of an AP.
serialNumber required | string The serial number of the AP. |
Array of objects (ApLanPort) | |
poeOut | boolean Default: false |
useVenueSettings | boolean Default: false |
{- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": false,
- "useVenueSettings": false
}
{- "requestId": "string"
}
Get the AP MDNS proxy settings.
serialNumber required | string The serial number of the AP. |
{- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}
Update the AP MDNS proxy settings.
serialNumber required | string The serial number of the AP. |
required | Array of objects (BonjourGatewayRule) [ 1 .. 2147483647 ] items |
{- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}
{- "requestId": "string"
}
Start packet capture.
serialNumber required | string |
captureInterface required | string Enum: "RADIO24" "RADIO50" "RADIO50UPPER" "RADIO50LOWER" "RADIO60" "ETH0" "ETH1" "ETH2" "ETH3" "ETH4" "ETH5" "ETH6" "ETH7" |
frameTypeFilter | Array of strings Items Enum: "MANAGEMENT" "CONTROL" "DATA" |
macAddressFilter | string^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$|... |
{- "captureInterface": "RADIO24",
- "frameTypeFilter": [
- "MANAGEMENT"
], - "macAddressFilter": "string"
}
{- "requestId": "string"
}
Get AP radio details.
serialNumber required | string The serial number of the AP. |
{- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParamsDual5G": {
- "enabled": true,
- "lower5gEnabled": false,
- "radioParamsLower5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "upper5gEnabled": false
}, - "enable24G": false,
- "enable50G": false,
- "enable6G": false,
- "useVenueSettings": true
}
Update an AP radio settings.
serialNumber required | string The serial number of the AP. |
object (ApRadioParams24G) AP radio customization for 2.4GHz. | |
object (ApRadioParams50G) AP radio customization for 5GHz. | |
object (ApRadioParams6G) AP radio customization for 6GHz. | |
object (ApRadioParamsDual5G) AP radio customization for dual 5GHz radios. | |
enable24G | boolean Default: false |
enable50G | boolean Default: false |
enable6G | boolean Default: false |
useVenueSettings | boolean Default: true |
{- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "mgmtTxRate6G": "6",
- "txPower": "MAX"
}, - "apRadioParamsDual5G": {
- "enabled": true,
- "lower5gEnabled": false,
- "radioParamsLower5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "upper5gEnabled": false
}, - "enable24G": false,
- "enable50G": false,
- "enable6G": false,
- "useVenueSettings": true
}
{- "requestId": "string"
}
GET AP customization details.
serialNumber required | string |
{- "externalAntenna": {
- "coupled": false,
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "supportDisable": false
}, - "id": "string",
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": false,
- "useVenueSettings": false
}
Update the customization of an AP.
serialNumber required | string |
object (ExternalAntenna) External antenna settings | |
Array of objects (ApLanPort) | |
poeOut | boolean Default: false |
useVenueSettings | boolean Default: false |
{- "externalAntenna": {
- "coupled": false,
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "supportDisable": false
}, - "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": false,
- "useVenueSettings": false
}
{- "requestId": "string"
}
Manage Wi-Fi venue configuration, including radio settings, mesh, LEDs, LAN-ports, and syslog.
[- {
- "apPassword": "string",
- "bandBalancing": {
- "clientPercent24": "MjU=",
- "enabled": false
}, - "countryCode": "string",
- "denialOfServiceProtection": {
- "blockingPeriod": 60,
- "checkPeriod": 30,
- "enabled": false,
- "failThreshold": 5
}, - "dhcpServiceSetting": {
- "dhcpServiceAps": [
- {
- "dhcpIps": [
- "string"
], - "role": "PrimaryServer",
- "serialNumber": "stringstring"
}
], - "dhcpServiceProfileIds": [
- "string"
], - "enableClientIsolationAllowlist": false,
- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic"
}, - "enableClientIsolationAllowlist": false,
- "id": "string",
- "lteBandLockChannels": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "mesh": {
- "enabled": false
}, - "radioCustomization": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "combineChannels": false,
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "scanInterval": 10,
- "txPower": "MAX"
}, - "radioParamsDual5G": {
- "enabled": false,
- "inheritParamsLower5G": true,
- "inheritParamsUpper5G": true,
- "radioParamsLower5G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}
}
}, - "rogueAp": {
- "enabled": false,
- "reportThreshold": 0,
- "roguePolicyId": "string"
}, - "syslog": {
- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "GENERAL_LOGS",
- "port": 514,
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}, - "tenantId": "string",
- "wifiFirmwareVersion": "string"
}
]
{- "apModels": [
- {
- "allowCbandCountry": [
- "string"
], - "allowDfsCountry": [
- "string"
], - "canSupportCellular": false,
- "canSupportLacp": false,
- "canSupportPoeMode": false,
- "canSupportPoeOut": false,
- "capabilityScore": 0,
- "externalAntenna": {
- "coupled": false,
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "supportDisable": false
}, - "has160MHzChannelBandwidth": false,
- "isOutdoor": false,
- "lanPortPictureDownloadUrl": "string",
- "lanPorts": [
- {
- "defaultType": "string",
- "displayLabel": "string",
- "id": "string",
- "isPoeOutPort": false,
- "isPoePort": false,
- "supportDisable": false,
- "trunkPortOnly": false,
- "untagId": 0,
- "vlanMembers": "string"
}
], - "ledOn": false,
- "lldpAdInterval": 0,
- "lldpEnable": false,
- "lldpHoldTime": 0,
- "lldpMgmtEnable": false,
- "maxChannelization24G": 0,
- "maxChannelization5G": 0,
- "maxChannelization6G": 0,
- "model": "string",
- "pictureDownloadUrl": "string",
- "poeModeCapabilities": [
- "string"
], - "primaryWanRecoveryTimer": 0,
- "requireOneEnabledTrunkPort": false,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "string",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "string",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "support11AX": false,
- "supportChannel144": false,
- "supportDual5gMode": false,
- "supportTriRadio": false,
- "version": "string",
- "wanConnection": "string"
}
]
}
Get AP model cellular settings and LTE band lock channels of the venue.
venueId required | string |
{- "model": "string",
- "primarySim": {
- "apn": "string",
- "enabled": true,
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "networkSelection": "AUTO",
- "roaming": true
}, - "primaryWanRecoveryTimer": 10,
- "secondarySim": {
- "apn": "string",
- "enabled": true,
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "networkSelection": "AUTO",
- "roaming": true
}, - "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}
Update AP model cellular settings and LTE band lock channels of the venue.
venueId required | string |
model | string [ 0 .. 64 ] characters |
object (SimSettings) SIM setting object. | |
primaryWanRecoveryTimer required | integer <int32> [ 10 .. 300 ] |
object (SimSettings) SIM setting object. | |
wanConnection required | string Enum: "ETH_WITH_CELLULAR_FAILOVER" "CELLULAR_WITH_ETH_FAILOVER" "ETH" "CELLULAR" |
{- "model": "string",
- "primarySim": {
- "apn": "string",
- "enabled": true,
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "networkSelection": "AUTO",
- "roaming": true
}, - "primaryWanRecoveryTimer": 10,
- "secondarySim": {
- "apn": "string",
- "enabled": true,
- "lteBands": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "networkSelection": "AUTO",
- "roaming": true
}, - "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}
{- "requestId": "string"
}
Get venue default regulatory channels.
venueId required | string Venue ID |
{- "2.4GChannels": {
- "20MHz": [
- "1"
], - "40MHz": [
- "1"
], - "auto": [
- "1"
]
}, - "5GChannels": {
- "dfs": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoorForOutdoorAp": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "outdoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}
}, - "5GLowerChannels": {
- "dfs": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoorForOutdoorAp": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "outdoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}
}, - "5GUpperChannels": {
- "dfs": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "indoorForOutdoorAp": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "outdoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}
}, - "6GChannels": {
- "160MHz": [
- "1"
], - "20MHz": [
- "1"
], - "40MHz": [
- "1"
], - "80MHz": [
- "1"
], - "auto": [
- "1"
]
}
}
Get a list of this DHCP service settings of this venue.
venueId required | string Venue ID |
{- "dhcpServiceAps": [
- {
- "dhcpIps": [
- "string"
], - "role": "PrimaryServer",
- "serialNumber": "stringstring"
}
], - "dhcpServiceProfileIds": [
- "string"
], - "enableClientIsolationAllowlist": false,
- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic"
}
Update DHCP service settings of this venue.
venueId required | string Venue ID |
Array of objects (DhcpServiceAp) | |
dhcpServiceProfileIds | Array of strings |
enableClientIsolationAllowlist | boolean Default: false |
enabled | boolean Default: false |
mode | string Default: "DhcpModeEnum.EnableOnEachAPs" Enum: "EnableOnEachAPs" "EnableOnMultipleAPs" "EnableOnHierarchicalAPs" |
wanPortSelectionMode | string Default: "DhcpWanPortSelectionModeEnum.Dynamic" Enum: "Dynamic" "Manual" |
{- "dhcpServiceAps": [
- {
- "dhcpIps": [
- "string"
], - "role": "PrimaryServer",
- "serialNumber": "stringstring"
}
], - "dhcpServiceProfileIds": [
- "string"
], - "enableClientIsolationAllowlist": false,
- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic"
}
{- "requestId": "string"
}
Get a list of DHCP leases of the venue.
venueId required | string Venue ID |
[- {
- "dhcpProfileId": "string",
- "dhcpProfileName": "string",
- "hostname": "string",
- "ipAddress": "string",
- "leaseExpiration": "string",
- "macAddress": "string",
- "status": "string"
}
]
Get a list of DHCP pool usage of the venue.
venueId required | string Venue ID |
[- {
- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "totalIpCount": 0,
- "usedIpCount": 0,
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
]
Update venue directed multicast settings of this venue.
venueId required | string Venue ID |
networkEnabled | boolean Default: true |
wiredEnabled | boolean Default: true |
wirelessEnabled | boolean Default: true |
{- "networkEnabled": true,
- "wiredEnabled": true,
- "wirelessEnabled": true
}
{- "requestId": "string"
}
Update DoS protection of this venue.
venueId required | string Venue ID |
blockingPeriod | integer <int32> [ 30 .. 600 ] Default: 60 |
checkPeriod | integer <int32> [ 30 .. 600 ] Default: 30 |
enabled | boolean Default: false |
failThreshold | integer <int32> [ 2 .. 25 ] Default: 5 |
{- "blockingPeriod": 60,
- "checkPeriod": 30,
- "enabled": false,
- "failThreshold": 5
}
{- "requestId": "string"
}
List venue external antenna settings. The settings are defined per AP model.
venueId required | string |
[- {
- "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 |
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"
}
List venue LAN-port settings. The settings are defined per AP model.
venueId required | string Venue ID |
[- {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "model": "string",
- "poeMode": "Auto",
- "poeOut": false
}
]
Update a venue LAN-port settings. The settings are defined per AP model.
venueId required | string Venue ID |
Array of objects (VenueLanPort) | |
model | string [ 0 .. 64 ] characters |
poeMode | string Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8" |
poeOut | boolean Default: false |
[- {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "model": "string",
- "poeMode": "Auto",
- "poeOut": false
}
]
{- "requestId": "string"
}
Update venue LED settings. The settings are defined per AP model.
venueId required | string Venue ID |
ledEnabled | boolean Default: false |
model | string [ 0 .. 64 ] characters |
[- {
- "ledEnabled": false,
- "model": "string"
}
]
{- "requestId": "string"
}
Enable/disable the venue mesh.
venueId required | string Venue ID |
enabled | boolean Default: false |
{- "enabled": false
}
{- "requestId": "string"
}
Get the venue radio.
venueId required | string Venue ID |
defaultOnly | boolean Default: false Only get the details of default radio settings in this venue. |
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "combineChannels": false,
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "scanInterval": 10,
- "txPower": "MAX"
}, - "radioParamsDual5G": {
- "enabled": false,
- "inheritParamsLower5G": true,
- "inheritParamsUpper5G": true,
- "radioParamsLower5G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}
}
}
Update the venue radio.
venueId required | string Venue ID |
object (RadioParams24G) Radio customization for 2.4GHz. | |
object (RadioParams50G) Radio customization for 5GHz. | |
object (RadioParams6G) Radio customization for 6GHz. | |
object (RadioParamsDual5G) Radio customization for dual 5GHz radios. |
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "combineChannels": false,
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "mgmtTxRate6G": "6",
- "scanInterval": 10,
- "txPower": "MAX"
}, - "radioParamsDual5G": {
- "enabled": false,
- "inheritParamsLower5G": true,
- "inheritParamsUpper5G": true,
- "radioParamsLower5G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}
}
}
{- "requestId": "string"
}
Update the venue rogue AP settings.
venueId required | string Venue ID |
enabled | boolean Default: false |
reportThreshold | integer <int32> [ 0 .. 100 ] Default: 0 |
roguePolicyId | string |
{- "enabled": false,
- "reportThreshold": 0,
- "roguePolicyId": "string"
}
{- "requestId": "string"
}
Update a venue syslog server profile settings.
venueId required | string Venue ID |
enabled | boolean Default: false |
serviceProfileId | string |
{- "enabled": false,
- "serviceProfileId": "string"
}
{- "requestId": "string"
}
Get the venue syslog settings.
venueId required | string Venue ID |
{- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "GENERAL_LOGS",
- "port": 514,
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}
Update the venue syslog settings.
venueId required | string Venue ID |
enabled | boolean Default: false |
facility | string Default: "FacilityEnum.KEEP_ORIGINAL" Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7" |
flowLevel | string Default: "FlowLevelEnum.CLIENT_FLOW" Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL" |
port | integer <int32> [ 1 .. 65535 ] Default: 514 |
priority | string Default: "PriorityEnum.INFO" Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL" |
protocol | string Default: "ProtocolEnum.UDP" Enum: "TCP" "UDP" |
secondaryPort | integer <int32> [ 1 .. 65535 ] Default: 514 |
secondaryProtocol | string Default: "ProtocolEnum.TCP" Enum: "TCP" "UDP" |
secondaryServer | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
server | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
{- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "GENERAL_LOGS",
- "port": 514,
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}
{- "requestId": "string"
}
{- "apPassword": "string",
- "bandBalancing": {
- "clientPercent24": "MjU=",
- "enabled": false
}, - "countryCode": "string",
- "denialOfServiceProtection": {
- "blockingPeriod": 60,
- "checkPeriod": 30,
- "enabled": false,
- "failThreshold": 5
}, - "dhcpServiceSetting": {
- "dhcpServiceAps": [
- {
- "dhcpIps": [
- "string"
], - "role": "PrimaryServer",
- "serialNumber": "stringstring"
}
], - "dhcpServiceProfileIds": [
- "string"
], - "enableClientIsolationAllowlist": false,
- "enabled": false,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic"
}, - "enableClientIsolationAllowlist": false,
- "id": "string",
- "lteBandLockChannels": [
- {
- "band3G": [
- "string"
], - "band4G": [
- "string"
], - "region": "DOMAIN_1"
}
], - "mesh": {
- "enabled": false
}, - "radioCustomization": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "combineChannels": false,
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "scanInterval": 10,
- "txPower": "MAX"
}, - "radioParamsDual5G": {
- "enabled": false,
- "inheritParamsLower5G": true,
- "inheritParamsUpper5G": true,
- "radioParamsLower5G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "method": "MANUAL",
- "scanInterval": 20,
- "txPower": "Auto"
}
}
}, - "rogueAp": {
- "enabled": false,
- "reportThreshold": 0,
- "roguePolicyId": "string"
}, - "syslog": {
- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "GENERAL_LOGS",
- "port": 514,
- "priority": "EMERGENCY",
- "protocol": "TCP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}, - "tenantId": "string",
- "wifiFirmwareVersion": "string"
}
Update the PSK for the recovery network.
obsolete | boolean Default: false |
psk | string^([0-9]{4}){4}$ |
{- "obsolete": false,
- "psk": "string"
}
{- "requestId": "string"
}
{- "apModels": [
- {
- "allowCbandCountry": [
- "string"
], - "allowDfsCountry": [
- "string"
], - "canSupportCellular": false,
- "canSupportLacp": false,
- "canSupportPoeMode": false,
- "canSupportPoeOut": false,
- "capabilityScore": 0,
- "externalAntenna": {
- "coupled": false,
- "enable24G": false,
- "enable50G": false,
- "gain24G": 60,
- "gain50G": 60,
- "supportDisable": false
}, - "has160MHzChannelBandwidth": false,
- "isOutdoor": false,
- "lanPortPictureDownloadUrl": "string",
- "lanPorts": [
- {
- "defaultType": "string",
- "displayLabel": "string",
- "id": "string",
- "isPoeOutPort": false,
- "isPoePort": false,
- "supportDisable": false,
- "trunkPortOnly": false,
- "untagId": 0,
- "vlanMembers": "string"
}
], - "ledOn": false,
- "lldpAdInterval": 0,
- "lldpEnable": false,
- "lldpHoldTime": 0,
- "lldpMgmtEnable": false,
- "maxChannelization24G": 0,
- "maxChannelization5G": 0,
- "maxChannelization6G": 0,
- "model": "string",
- "pictureDownloadUrl": "string",
- "poeModeCapabilities": [
- "string"
], - "primaryWanRecoveryTimer": 0,
- "requireOneEnabledTrunkPort": false,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "string",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "string",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "support11AX": false,
- "supportChannel144": false,
- "supportDual5gMode": false,
- "supportTriRadio": false,
- "version": "string",
- "wanConnection": "string"
}
]
}
Control a list of clients.
action required | string Value: "disconnect" |
Array of objects (DisconnectClientBySerialNumber) |
{- "action": "disconnect",
- "clients": [
- {
- "clientMac": "string",
- "serialNumber": "string"
}
]
}
{- "requestId": "string"
}
Create a new network-venue activation.
allApGroupsRadio | string Deprecated Default: "RadioEnum.Both" Enum: "Both" "2.4-GHz" "5-GHz" |
allApGroupsRadioTypes | Array of strings Items Enum: "2.4-GHz" "5-GHz" "6-GHz" |
allApGroupsVlanId | integer <int32> [ 1 .. 4094 ] |
Array of objects (NetworkApGroup) | |
clientIsolationAllowlistId | string |
isAllApGroups | boolean Default: true |
networkId | string |
object (NetworkVenueScheduler) Network-Venue scheduler | |
venueId | string |
vlanPoolId | string |
{- "allApGroupsRadio": "Both",
- "allApGroupsRadioTypes": [
- "2.4-GHz"
], - "allApGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "isDefault": false,
- "radio": "Both",
- "radioTypes": [
- "2.4-GHz"
], - "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "clientIsolationAllowlistId": "string",
- "isAllApGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
{- "requestId": "string"
}
Get network-venue activation list.
networkId | string |
page | integer <int32> Default: 1 |
pageSize | integer <int32> Default: 25 |
venueId | string |
{- "networkId": "string",
- "page": 1,
- "pageSize": 25,
- "venueId": "string"
}
{- "data": [
- {
- "allApGroupsRadio": "Both",
- "allApGroupsRadioTypes": [
- "2.4-GHz"
], - "allApGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "radioTypes": [
- "2.4-GHz"
], - "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "clientIsolationAllowlistId": "string",
- "dual5gEnabled": false,
- "id": "string",
- "isAllApGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "tripleBandEnabled": false,
- "venueId": "string",
- "vlanPoolId": "string"
}
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}
Get the network-venue activation details.
networkVenueId required | string Network-Venue ID |
{- "allApGroupsRadio": "Both",
- "allApGroupsRadioTypes": [
- "2.4-GHz"
], - "allApGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "radioTypes": [
- "2.4-GHz"
], - "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "clientIsolationAllowlistId": "string",
- "dual5gEnabled": false,
- "id": "string",
- "isAllApGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "tripleBandEnabled": false,
- "venueId": "string",
- "vlanPoolId": "string"
}
Update this network-venue activation.
networkVenueId required | string Network-Venue ID |
allApGroupsRadio | string Deprecated Default: "RadioEnum.Both" Enum: "Both" "2.4-GHz" "5-GHz" |
allApGroupsRadioTypes | Array of strings Items Enum: "2.4-GHz" "5-GHz" "6-GHz" |
allApGroupsVlanId | integer <int32> [ 1 .. 4094 ] |
Array of objects (NetworkApGroup) | |
clientIsolationAllowlistId | string |
isAllApGroups | boolean Default: true |
networkId | string |
object (NetworkVenueScheduler) Network-Venue scheduler | |
venueId | string |
vlanPoolId | string |
{- "allApGroupsRadio": "Both",
- "allApGroupsRadioTypes": [
- "2.4-GHz"
], - "allApGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "isDefault": false,
- "radio": "Both",
- "radioTypes": [
- "2.4-GHz"
], - "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorSsidAlreadyActivated": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "clientIsolationAllowlistId": "string",
- "isAllApGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
{- "requestId": "string"
}
Get list of DHCP service-profiles.
excludeDefault | boolean Default: false |
[- {
- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
]
Create a new DHCP service-profile.
endIpAddress required | 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 ] |
name required | string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$ |
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][... |
startIpAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
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... |
Array of objects (IdAndName) | |
vlanId required | integer <int32> [ 1 .. 4094 ] |
{- "endIpAddress": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
{- "requestId": "string"
}
Get the DHCP service-profile details.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
{- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
Update a DHCP service-profile.
dhcpServiceProfileId required | string DHCP Service-Profile ID |
endIpAddress required | 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 ] |
name required | string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$ |
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][... |
startIpAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][... |
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... |
Array of objects (IdAndName) | |
vlanId required | integer <int32> [ 1 .. 4094 ] |
{- "endIpAddress": "string",
- "leaseTimeHours": 24,
- "leaseTimeMinutes": 59,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
{- "requestId": "string"
}
[- {
- "aps": [
- {
- "apGroupId": "string",
- "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "deviceGps": {
- "latitude": "string",
- "longitude": "string"
}, - "externalIp": "null",
- "firmware": "null",
- "indoorModel": false,
- "ip": "null",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": false,
- "useVenueSettings": false
}, - "lastContacted": "null",
- "lastUpdated": "null",
- "mac": "null",
- "meshRole": "null",
- "model": "null",
- "name": "string",
- "poePortStatus": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParamsDual5G": {
- "enabled": true,
- "lower5gEnabled": false,
- "radioParamsLower5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "upper5gEnabled": false
}, - "enable24G": false,
- "enable50G": false,
- "enable6G": false,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "string"
}
]
{- "aps": [
- {
- "apGroupId": "string",
- "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "deviceGps": {
- "latitude": "string",
- "longitude": "string"
}, - "externalIp": "null",
- "firmware": "null",
- "indoorModel": false,
- "ip": "null",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": false,
- "useVenueSettings": false
}, - "lastContacted": "null",
- "lastUpdated": "null",
- "mac": "null",
- "meshRole": "null",
- "model": "null",
- "name": "string",
- "poePortStatus": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParamsDual5G": {
- "enabled": true,
- "lower5gEnabled": false,
- "radioParamsLower5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "upper5gEnabled": false
}, - "enable24G": false,
- "enable50G": false,
- "enable6G": false,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "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 |
Array of objects (ApSerialNumber) | |
description | string [ 2 .. 180 ] characters |
name required | string [ 2 .. 64 ] characters |
venueId | string Deprecated |
{- "apSerialNumbers": [
- {
- "serialNumber": "string",
- "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z"
}
], - "description": "string",
- "name": "string",
- "venueId": "string"
}
{- "requestId": "string"
}
Get the AP-group list by venue.
venueId required | string Venue ID |
defaultOnly | boolean Default: false Only get the details of default AP Group in this venue. |
[- {
- "aps": [
- {
- "apGroupId": "string",
- "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "deviceGps": {
- "latitude": "string",
- "longitude": "string"
}, - "externalIp": "null",
- "firmware": "null",
- "indoorModel": false,
- "ip": "null",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": false,
- "useVenueSettings": false
}, - "lastContacted": "null",
- "lastUpdated": "null",
- "mac": "null",
- "meshRole": "null",
- "model": "null",
- "name": "string",
- "poePortStatus": "null",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "apRadioParams6G": {
- "allowedChannels": [
- "1"
], - "bssMinRate6G": "HE_MCS_0",
- "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "mgmtTxRate6G": "6",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParamsDual5G": {
- "enabled": true,
- "lower5gEnabled": false,
- "radioParamsLower5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "radioParamsUpper5G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 33,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "MANUAL",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "Auto"
}, - "upper5gEnabled": false
}, - "enable24G": false,
- "enable50G": false,
- "enable6G": false,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "string"
}
]
Create a new AP-group.
venueId required | string Venue ID |
Array of objects (ApSerialNumber) | |
description | string [ 2 .. 180 ] characters |
name required | string [ 2 .. 64 ] characters |
venueId | string Deprecated |
{- "apSerialNumbers": [
- {
- "serialNumber": "string",
- "softDeleted": false,
- "softDeletedDate": "2019-08-24T14:15:22Z"
}
], - "description": "string",
- "name": "string",
- "venueId": "string"
}
{- "requestId": "string"
}
Manage rogue classification policies.
Rogue APs are Wi-Fi APs which are in radio range of your Wi-Fi network, but are unknown to the Ruckus cloud. For example, these may be APs in installed your venues without explicit authorization from your administrators, whether added by a well-meaning employee or by a malicious attacker; as such, they could be on the same LAN as your authorized APs. They could also be APs installed in nearby venues (for example, if your venue is part of a multi-tenant facility). Rogue classification polices help to automatically classify these unknown APs by setting up rules which trigger a rogue AP report when specific-rogue detection criteria are met.
Get a list of rogue classification policies.
excludeDefault | boolean Default: false |
[- {
- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "classification": "Ignored",
- "moreInfo": "string",
- "name": "string",
- "priority": 1,
- "type": "AdhocRule"
}
], - "venues": [
- {
- "id": "string",
- "name": "string"
}
]
}
]
Create a rogue classification policy.
description | string [ 0 .. 255 ] characters |
name required | string [ 2 .. 32 ] characters |
Array of objects (RogueClassificationPolicyRule) | |
Array of objects (IdAndName) |
{- "description": "string",
- "name": "string",
- "rules": [
- {
- "classification": "Ignored",
- "moreInfo": "string",
- "name": "string",
- "priority": 1,
- "type": "AdhocRule"
}
], - "venues": [
- {
- "id": "string",
- "name": "string"
}
]
}
{- "requestId": "string"
}
Get this rogue classification policy.
roguePolicyId required | string Rogue classification policy ID. |
{- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "classification": "Ignored",
- "moreInfo": "string",
- "name": "string",
- "priority": 1,
- "type": "AdhocRule"
}
], - "venues": [
- {
- "id": "string",
- "name": "string"
}
]
}
Update this rogue classification policy.
roguePolicyId required | string Rogue classification policy ID. |
description | string [ 0 .. 255 ] characters |
name required | string [ 2 .. 32 ] characters |
Array of objects (RogueClassificationPolicyRule) | |
Array of objects (IdAndName) |
{- "description": "string",
- "name": "string",
- "rules": [
- {
- "classification": "Ignored",
- "moreInfo": "string",
- "name": "string",
- "priority": 1,
- "type": "AdhocRule"
}
], - "venues": [
- {
- "id": "string",
- "name": "string"
}
]
}
{- "requestId": "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. |
[- "string"
]
{- "requestId": "string"
}
Bind a rogue classification policy to a list of venues.
roguePolicyId required | string Rogue classification policy ID. |
[- "string"
]
{- "requestId": "string"
}
Import DPSK passphrases from CSV file.
networkId required | string |
usernamePrefix | string [ 0 .. 190 ] characters |
file required | string <binary> |
{- "requestId": "string"
}
Get result for import APs from CSV file.
requestId required | string The request-id of import aps request for querying the result. |
{- "downloadUrl": "string",
- "errors": [
- {
- "code": 0,
- "description": "string"
}
], - "fileErrorsCount": 0,
- "txId": "string"
}