Virtual SmartZone (High Scale) Public API Reference Guide

Overview

This reference guide describes the public APIs supported by the Virtual SmartZone (High Scale). Use the RESTful API commands described in this guide as an alternative way to manage the controller and its managed APs (in addition to the web and command line interfaces).

All API URIs in this guide use the common prefix “https://{host}:7443/api/public“, where {host} is the IP address of the management interface of the controller.

Common Request Header

The following parameters are required in the HTTP headers of all API requests (except for the logon API).

Parameter	Value
Content-Type	“application/json;charset=UTF-8”
Cookie	“JSESSIONID={JSESSIONID}”

JSESSIONID is returned as the following parameter in the response header of the logon API.

Parameter	Value
Set-cookie	“JSESSIONID={JSESSIONID}; Path=/wsg; Secure”

HTTP Responses

Successful Requests

Code	Response	Description
200	`OK`	The request was completed successfully. Some API calls may return a 201 response instead.
201	`Created`	The request was completed successfully and a resource was created.
204	`No Content`	The request was completed successfully, but there was no representation to return (that is, the response was empty).

Failed Requests

Code	Response	Description
400	`Bad request`	The request could not be understood or was missing at least one required parameter.
401	`Unauthorized`	Authentication failed or you do not have the permission to perform the requested operation.
403	`Forbidden`	Access denied.
404	`Not found`	The resource could not be found.
405	`Method not allowed`	The requested method is unsupported for the resource.
406	`Not acceptable`	The controller is unable to send data in the format specified in the Accept header of the request.
422	`Unprocessable entity`	The request was well-formed but it could not be completed because of semantic errors.

Errors

Code	Response	Description
500	`Internal server error`	The request is valid, but the controller is unable to process the request.
503	`Service unavailable`	The service is temporary unavailable (for example, a scheduled maintenance). Please try again later.

Ruckus Wireless Error Codes

When the server is unable to process a request, Ruckus Wireless-specific error code and message are returned in the response body. The following table describes the list of Ruckus Wireless specific error codes.

Code	Response
0	`Internal server error`
101	`Bad HTTP request`
102	`Bad HTTP response`
103	`Invalid HTTP request body`
104	`HTTP response body cannot be generated`
105	`Unsupported API version`
150	`Cluster not in service`
151	`Controller node not in service`
201	`No active session`
202	`Login denied`
211	`Insufficient administrative privileges`
212	`Resource access denied`
301	`Resource cannot be found`
302	`Business rule violation`

Change Logs

What’s New
- Ruckus Wireless AP Zone
  - Retrieve
  - Create Zone of IPV6
  - Modify Radio 2.4G/5G
  - Modify/Disable Syslog
  - Modify/Disable Smart Monitor
  - Modify/Disable Client Admission Control 2.4G/5G
  - Modify Tunnel Profile
  - Modify/Disable Background Scanning 2.4G/5G
  - Modify/Disable Client Load Balancing 2.4G/5G
  - Modify/Disable Band Balancing
  - Modify AP Reboot Timeout
  - Modify Node Affinity Profile
  - Modify/Clear Hotspot2.0 Venue Profile
  - Modify/Disable Rogue
  - Modify/Disable Location Based Service
  - Retrieve/Modify AP Model
- AP Group
  - Disable Location Override
  - Disable Location AdditonalInfo Override
  - Modify/Disable Radio 2.4G/5G Override
  - Modify/Disable WLAN group 2.4G/5G
  - Modify/Disable Location Based Service Override
  - Modify/Disable Client Admission Control 2.4G/5G
  - Modify/Clear Hotspot2.0 Venue Profile
  - Retrieve/Modify/Disable AP Model
- Access Point Configuration
  - Disable Location Override
  - Disable Location AdditonalInfo Override
  - Modify/Disable Smart Monitor
  - Modify/Disable Bonjour Gateway
  - Modify/Disable Client Admission Control 2.4G/5G
  - Modify/Clear Hotspot2.0 Venue Profile
  - Modify User Location Info
  - Modify/Disable Model Specific
- Access Point Operational
  - Retrieve Mesh Neighbor AP List
  - Retrieve Rogue AP List
- WLAN Group
  - Modify Member VLAN Pooling
  - Disable Member VLAN Override
  - Disable Member NAS Override
- WLAN
  - Create - Hotstpot2.0
  - Create Hotspot2.0 OSEN
  - Modify/Disable DiffServ Profile
  - Enable/Modify/Disable Qos Map Set
  - Modify Online Sign Service
  - Disable Zero-IT Onboarding(belong to Online Signup Service)
- AAA
- Zone - Web Authentication
- Zone - Guest Access
- Zone - Hotspot Service
- Zone - Hotspot2.0 WLAN Profile
- Authentication Service
- Accounting Service
- Profile(including Authentication & Accounting)
- Hotspot Profile
- Online Singup Profile
- Hotspot2.0 Venue Profile
- Hotspot2.0 Wi-Fi Operator Profile
- Hotspot2.0 Identity Provider Profile
- Certificate
- System
  - System Statistics
  - System Inventory
Changes
- Ruckus Wireless AP Zone
  - Modify Basic
    - attributes added “channelModeEnabled”, “tunnelType”, “location”, “locationAdditionalInfo”, “latitude”, “longitude”, “vlanOverlappingEnabled”
- AP Group
  - Retrieve
    - attributes added “location”, “locationAdditionalInfo”, “latitude”, “longitude”, “wifi24”, “wifi50”, “wlanGroup24”, “wlanGroup50”, “locationBasedService”, “clientAdmissionControl24”, “clientAdmissionControl50”, “venueProfile”
  - Modify Basic
    - attributes added “location”, “locationAdditionalInfo”, “latitude”, “longitude”
- Access Point Configuration
  - Retrieve
    - attributes added “locationAdditionalInfo”, “userLocationInfo”, “wlanService24Enabled”, “wlanService50Enabled”, “smartMonitor”, “bonjouarGateway”, “clientAdmissionControl24”, “clientAdmissionControl50”, “venueProfile”, “specific”
  - Modify Basic
    - attributes added “locationAdditionalInfo”, “wlanService24Enabled”, “wlanService50Enabled”
  - Modify Radio 2.4G Override
    - attribute “channelWidth” remove 0 & 40
- WLAN Group
  - Add Member
    - attributes added “vlanPooling”, “nasId”, remove 0 mean not overrided of attribute “accessVlan”
- WLAN
  - Retrieve
    - attributes added “hessid”, “diffServProfile”, “qosMaps”, “onlineSignupService”, “bypassCNA”
    - attribute “type” added “Hotspot20_OSEN”
    - attribute “encryption” added “mfp”
    - attribute “authServiceOrProfile” added “locationDeliveryEnabled”
    - attribute “coreTunnelProfile” added “operatorRealm”
    - attribute “vlan” added “vlanPooling”
    - attribute “advancedOptions” added “pmkCachingEnabled”, “okcEnabled”, removed “uplinkRateLimiting”, “downlinkRateLimiting”
  - Modify Basic
    - attributes added “hessid”, “bypassCNA”
  - Modify Authentication
    - attribute added “locationDeliveryEnabled”
  - Modify Encryption
    - attribute added “mfp”
  - Modify Core Tunnel
    - attribute added “operatorRealm”, also “Bridge” required Forwording Profile
  - Modify VLAN
    - attribute added “vlanPooling”
  - Modify Advanced Options
    - attribute “advancedOptions” added “pmkCachingEnabled”, “okcEnabled”, removed “uplinkRateLimiting”, “downlinkRateLimiting”
Backward Compatible Notice
- WLAN
  - Create - Hotstpot2.0
    - this is totally changed compare with previous version
  - Modify Advanced Options
    - as attributes “uplinkRateLimiting”, “downlinkRateLimiting” removed, so they could not be effected with previous version

The APIs are used to acquire/retrieve/release login session.

POST

/v2_1/session

Use this API command to log on to the controller and acquire a valid logon session.

RequestShowHide

Body

{
    "username" : "admin",
    "password" : "admin!234",
    "apiVersions" : [ "1", "2" ],
    "timeZoneUtcOffset" : "+08:00"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "username" : {
            "description" : "Logon user name",
            "type" : "string"
        },
        "password" : {
            "description" : "Logon password",
            "type" : "string"
        },
        "domainName" : {
            "description" : "Logon domain name",
            "type" : "string"
        },
        "apiVersions" : {
            "description" : "API version supported by the client",
            "type" : "array",
            "items" : {
                "type" : "string"
            },
            "minItems" : 1,
            "uniqueItems" : true
        },
        "timeZoneUtcOffset" : {
            "description" : "Local timezone of the client, offset to UTC",
            "enum" : [ "-12:00", "-11:00", "-10:00", "-09:30", "-09:00", "-08:00", "-07:00", "-06:00", "-05:00", "-04:30", "-04:00", "-03:30", "-03:00", "-02:00", "-01:00", "+00:00", "-00:00", "±00:00", "+01:00", "+02:00", "+03:00", "+03:30", "+04:00", "+04:30", "+05:00", "+05:30", "+05:45", "+06:00", "+06:30", "+07:00", "+08:00", "+08:45", "+09:00", "+09:30", "+10:00", "+10:30", "+11:00", "+11:30", "+12:00", "+12:45", "+13:00", "+14:00" ]
        }
    },
    "required" : [ "username", "password" ]
}

Response 200ShowHide

Body

{
    "apiVersion" : "1"
}

Schema

{
    "type" : "object",
    "properties" : {
        "controllerVersion" : {
            "type" : "string"
        }
    }
}

GET

/v2_1/session

Use this API command to retrieve information about the current logon session.

Response 200ShowHide

Body

{
    "cpId" : "DEV_BLADE_UUID",
    "domainId" : "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
    "adminRoleId" : "69962d35-9447-41a1-aff5-facf1e85c674",
    "mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
    "adminId" : "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
    "clientIp" : "172.18.193.1",
    "apiVersions" : [ "1_0" ],
    "timeZoneUtcOffset" : 0
}

Schema

{
    "type" : "object",
    "properties" : {
        "cpId" : {
            "type" : "string"
        },
        "domainId" : {
            "type" : "string"
        },
        "adminRoleId" : {
            "type" : "string"
        },
        "mvnoId" : {
            "type" : "string"
        },
        "adminId" : {
            "type" : "string"
        },
        "clientIp" : {
            "type" : "string"
        },
        "apiVersions" : {
            "description" : "API version supported by the client",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "timeZoneUtcOffset" : {
            "type" : "integer"
        }
    }
}

Ruckus Wireless AP Zone

Retrieve List

GET

/v2_1/rkszones

Use this API command to retrieve the list of Ruckus Wireless AP zones that belong to a domain.

Parameters
index
number (optional)
The index of the first entry to be retrieved. Default: 0

listSize
number (optional)
The maximum number of entries to be retrieved. Default: 100

domainId
string (optional)
The domain ID. Default: current logon domain ID

Response 200ShowHide

Body

{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "id" : "zoneUUID",
        "name" : "zoneName"
    }, {
        "id" : "zoneUUID2",
        "name" : "zoneName2"
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the zone",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the zone",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve

GET

/v2_1/rkszones/{id}

Use this API command to retrieve Ruckus Wireless AP zones configuration.

Response 200ShowHide

Body

{
    "id" : "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
    "domainId" : "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
    "name" : "public-api-zone-ipv6",
    "description" : null,
    "countryCode" : "US",
    "version" : "3.1.0.0.55",
    "timezone" : {
        "systemTimezone" : "UTC",
        "customizedTimezone" : null
    },
    "ipMode" : "IPV6",
    "login" : {
        "apLoginName" : "admin",
        "apLoginPassword" : "admin!234"
    },
    "mesh" : null,
    "wifi24" : {
        "txPower" : "Full",
        "channelWidth" : 20,
        "channel" : 0
    },
    "wifi50" : {
        "txPower" : "Full",
        "channelWidth" : 40,
        "indoorChannel" : 0,
        "outdoorChannel" : 0
    },
    "syslog" : null,
    "smartMonitor" : null,
    "clientAdmissionControl24" : null,
    "clientAdmissionControl50" : null,
    "channelModeEnabled" : false,
    "tunnelType" : "No_Tunneled",
    "tunnelProfile" : null,
    "backgroundScanning24" : null,
    "backgroundScanning50" : null,
    "clientLoadBalancing24" : null,
    "clientLoadBalancing50" : null,
    "bandBalancing" : null,
    "rogue" : null,
    "locationBasedService" : null,
    "apRebootTimeout" : {
        "gatewayLossTimeoutInSec" : 1800,
        "serverLossTimeoutInSec" : 7200
    },
    "location" : null,
    "locationAdditionalInfo" : null,
    "latitude" : null,
    "longitude" : null,
    "vlanOverlappingEnabled" : false,
    "nodeAffinityProfile" : null,
    "venueProfile" : null,
    "autoChannelSelection24" : {
        "channelSelectMode" : "ChannelFly"
    },
    "autoChannelSelection50" : {
        "channelSelectMode" : "BackgroundScanning"
    },
    "channelEvaluationInterval" : 777,
    "ipsecProfile" : {
        "id" : "ipsecProfileId",
        "name" : "ipsecProfileName"
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the zone",
            "type" : "string"
        },
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset ",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time start"
                        },
                        "end" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ],
                            "description" : "Daylight saving time end"
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
                    "description" : "User defined time zone"
                }
            }
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "AP administrator account"
        },
        "ipMode" : {
            "enum" : [ "IPV4", "IPV6" ],
            "description" : "IP mode of the zone"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            },
            "description" : "Mesh configuration of the zone."
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width (only 20 is currently supported)",
                    "enum" : [ 20 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
                }
            },
            "description" : "AP 2.4GHz radio configuration of the zone."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40, 80 ]
                },
                "indoorChannel" : {
                    "description" : "Indoor channel number",
                    "enum" : [ 0, 36, 40, 44, 48, 149, 153, 157, 161 ]
                },
                "outdoorChannel" : {
                    "description" : "Outdoor channel number",
                    "enum" : [ 0, 149, 153, 157, 161 ]
                }
            },
            "description" : "AP 5GHz radio configuration of the zone."
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "type" : "string",
                    "description" : "Address of the syslog server."
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            },
            "description" : "Syslog configuration of the zone."
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            },
            "description" : "Smart monitor configuration of the zone."
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 2.4GHz radio configuration of the zone."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "AP client admission control 5GHz radio configuration of the zone."
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "tunnel type configuration of the Zone. No_Tunneled -- for ipv6",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Tunnel type configuration of the zone."
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 2.4GHz radio configuration of the zone."
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "description" : "Background scanning on 5GHz radio configuration of the zone."
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone."
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            },
            "description" : "Client load balancing on 5GHz radio configuration of the zone."
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Band balancing configuration of the zone."
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Rogue AP detection configuration of the zone."
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the zone."
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            },
            "description" : "AP reboot timeout of the zone."
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the Zone."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the zone."
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the zone"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the zone"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Node affinity profile of the zone."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "venue profile configuration of the Zone."
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        }
    }
}

Retrieve Mesh Configuration

GET

/v2_1/rkszones/{id}/mesh

Use this API command to retrieve the mesh configuration of a zone.

Response 200ShowHide

Body

{
    "ssid" : "meshSSID",
    "passphrase" : "passphrase"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "ssid" : {
            "description" : "SSID of the mesh network",
            "type" : "string"
        },
        "passphrase" : {
            "description" : "Passphrase for the mesh network",
            "type" : "string"
        }
    }
}

Modify Mesh Configuration

PATCH

/v2_1/rkszones/{id}/mesh

Use this API command to enable mesh networking or update the mesh configuration.

RequestShowHide

Body

{
    "ssid" : "meshSSID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "ssid" : {
            "description" : "SSID of the mesh network",
            "type" : "string"
        },
        "passphrase" : {
            "description" : "Passphrase for the mesh network",
            "type" : "string"
        }
    },
    "description" : "Mesh configuration of the zone."
}

Response 204

Create Zone

POST

/v2_1/rkszones

Use this API command to create a new Ruckus Wireless AP zone.

RequestShowHide

Body

{
    "domainId" : "domainUUID",
    "name" : "zoneName",
    "login" : {
        "apLoginName" : "apLoginName",
        "apLoginPassword" : "apLoginPassword"
    },
    "description" : "description",
    "version" : "3.0.0.0.145",
    "countryCode" : "US"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "AP administrator account"
        }
    },
    "required" : [ "name", "login" ]
}

Response 201ShowHide

Body

{
    "id" : "zoneUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the zone",
            "type" : "string"
        }
    }
}

Create Zone of IPv6

POST

/v2_1/rkszones/ipv6

Use this API command to create a new Ruckus Wireless AP zone of IPv6.

RequestShowHide

Body

{
    "domainId" : "domainUUID",
    "name" : "zoneName",
    "login" : {
        "apLoginName" : "apLoginName",
        "apLoginPassword" : "apLoginPassword"
    },
    "description" : "description",
    "version" : "3.0.0.0.145",
    "countryCode" : "US"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "AP administrator account"
        }
    },
    "required" : [ "name", "login" ]
}

Response 201ShowHide

Body

{
    "id" : "zoneUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the zone",
            "type" : "string"
        }
    }
}

Modify Basic

PATCH

/v2_1/rkszones/{id}

Use this API command to modify the basic information of a zone.

RequestShowHide

Body

{
    "domainId" : "domainUUIDToMove",
    "name" : "zoneModified",
    "description" : "description modified",
    "version" : "3.0.0.0.175",
    "countryCode" : "US",
    "channelModeEnabled" : false,
    "tunnelType" : "RuckusGRE",
    "location" : "location",
    "locationAdditionalInfo" : "locationAdditionalInfo",
    "latitude" : 23,
    "longitude" : 23,
    "vlanOverlappingEnabled" : false,
    "channelEvaluationInterval" : 777
}

Schema

{
    "domainId" : {
        "description" : "Identifier of the management domain to which the zone belongs",
        "type" : "string"
    },
    "name" : {
        "type" : "string",
        "minLength" : 2,
        "maxLength" : 32,
        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
        "description" : "Name of the zone"
    },
    "description" : {
        "type" : [ "string", "null" ],
        "maxLength" : 64,
        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Description of the zone"
    },
    "version" : {
        "type" : "string",
        "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
        "description" : "AP firmware version of the zone"
    },
    "countryCode" : {
        "description" : "Country code of the zone",
        "type" : "string"
    },
    "channelModeEnabled" : {
        "description" : "Channel mode configuration of the zone.",
        "type" : "boolean"
    },
    "tunnelType" : {
        "description" : "tunnel type configuration of the Zone. No_Tunneled -- for ipv6",
        "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
    },
    "location" : {
        "type" : "string",
        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Location of the zone."
    },
    "locationAdditionalInfo" : {
        "type" : "string",
        "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
        "description" : "Location additional info of the zone."
    },
    "latitude" : {
        "type" : "number",
        "description" : "Latitude coordinate (in decimal format) of the zone"
    },
    "longitude" : {
        "type" : "number",
        "description" : "Longitude coordinate (in decimal format) of the zone"
    },
    "vlanOverlappingEnabled" : {
        "description" : "VLAN pooling overlapping of the zone",
        "type" : "boolean"
    },
    "channelEvaluationInterval" : {
        "description" : "channel evaluation Interval of the zone",
        "type" : "integer",
        "default" : 600,
        "minimum" : 60,
        "maximum" : 3600
    }
}

Response 204

Modify Time Zone

PATCH

/v2_1/rkszones/{id}/timezone

Use this API command to modify the time zone of a zone.

RequestShowHide

Body

{
    "customizedTimezone" : {
        "abbreviation" : "ABC",
        "gmtOffset" : 4,
        "gmtOffsetMinute" : 10
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "systemTimezone" : {
            "description" : "System defined time zone",
            "type" : "string"
        },
        "customizedTimezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "abbreviation" : {
                    "description" : "Time zone abbreviation",
                    "type" : "string",
                    "pattern" : "^[a-zA-Z]{3,4}$"
                },
                "gmtOffset" : {
                    "description" : "GMT offset ",
                    "type" : "integer",
                    "minimum" : -11,
                    "maximum" : 14
                },
                "gmtOffsetMinute" : {
                    "description" : "GMT offset minute",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 59
                },
                "start" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "month" : {
                            "description" : "Month when daylight saving time begins",
                            "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                        },
                        "week" : {
                            "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                            "enum" : [ 1, 2, 3, 4, 5 ]
                        },
                        "day" : {
                            "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                            "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                        },
                        "hour" : {
                            "description" : "Hour of the day",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 23
                        }
                    },
                    "required" : [ "month", "week", "day", "hour" ],
                    "description" : "Daylight saving time start"
                },
                "end" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "month" : {
                            "description" : "Month when daylight saving time begins",
                            "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                        },
                        "week" : {
                            "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                            "enum" : [ 1, 2, 3, 4, 5 ]
                        },
                        "day" : {
                            "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                            "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                        },
                        "hour" : {
                            "description" : "Hour of the day",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 23
                        }
                    },
                    "required" : [ "month", "week", "day", "hour" ],
                    "description" : "Daylight saving time end"
                }
            },
            "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
            "description" : "User defined time zone"
        }
    },
    "description" : "Either systemTimezone or customizedTimezone must be specified"
}

Response 204

Modify AP Logon

PATCH

/v2_1/rkszones/{id}/login

Use this API command to modify the AP logon information for APs that belong to a zone.

RequestShowHide

Body

{
    "apLoginName" : "apLoginName",
    "apLoginPassword" : "apLoginPassword"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "apLoginName" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
            "description" : "User name of the AP administrator"
        },
        "apLoginPassword" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
            "description" : "Password of the AP administrator"
        }
    },
    "required" : [ "apLoginName", "apLoginPassword" ],
    "description" : "AP administrator account"
}

Response 204

Modify Radio 2.4G

PATCH

/v2_1/rkszones/{id}/wifi24

Use this API command to modify the 2.4GHz radio configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "txPower" : "txPower",
    "channelWidth" : 1,
    "channel" : 13
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "txPower" : {
            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
            "description" : "Transmission power"
        },
        "channelWidth" : {
            "description" : "Channel width (only 20 is currently supported)",
            "enum" : [ 20 ]
        },
        "channel" : {
            "description" : "Channel number",
            "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
        }
    },
    "description" : "AP 2.4GHz radio configuration of the zone."
}

Response 204

Modify Radio 5G

PATCH

/v2_1/rkszones/{id}/wifi50

Use this API command to modify the 5GHz radio configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "txPower" : "txPower",
    "channelWidth" : 1,
    "indoorChannel" : 1,
    "outdoorChannel" : 2
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "txPower" : {
            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
            "description" : "Transmission power"
        },
        "channelWidth" : {
            "description" : "Channel width. Zero (0) means Auto.",
            "enum" : [ 0, 20, 40, 80 ]
        },
        "indoorChannel" : {
            "description" : "Indoor channel number",
            "enum" : [ 0, 36, 40, 44, 48, 149, 153, 157, 161 ]
        },
        "outdoorChannel" : {
            "description" : "Outdoor channel number",
            "enum" : [ 0, 149, 153, 157, 161 ]
        }
    },
    "description" : "AP 5GHz radio configuration of the zone."
}

Response 204

Modify Syslog

PATCH

/v2_1/rkszones/{id}/syslog

Use this API command to modify the syslog configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "address" : "1.1.1.1",
    "port" : 514,
    "facility" : "keep_Original",
    "priority" : "Error"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "address" : {
            "type" : "string",
            "description" : "Address of the syslog server."
        },
        "port" : {
            "description" : "Port number of the syslog server",
            "type" : "integer",
            "default" : 514,
            "minimum" : 1,
            "maximum" : 65535
        },
        "facility" : {
            "description" : "Facility of the syslog server",
            "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
            "default" : "keep_Original"
        },
        "priority" : {
            "description" : "Priority of the log messages",
            "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
            "default" : "Error"
        }
    },
    "description" : "Syslog configuration of the zone."
}

Response 204

Disable Syslog

DELETE

/v2_1/rkszones/{id}/syslog

Use this API command to disable syslog configuration for APs that belong to a zone.

Response 204

Modify Smart Monitor

PATCH

/v2_1/rkszones/{id}/smartMonitor

Use this API command to modify the smart monitor for APs that belong to a zone.

RequestShowHide

Body

{
    "intervalInSec" : 10,
    "retryThreshold" : 3
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "intervalInSec" : {
            "description" : "Interval in seconds. This is required if smartMonitor is enabled",
            "type" : "integer",
            "default" : 10,
            "minimum" : 5,
            "maximum" : 60
        },
        "retryThreshold" : {
            "description" : "Retry threshold. This is required if smartMonitor is enabled",
            "type" : "integer",
            "default" : 3,
            "minimum" : 1,
            "maximum" : 10
        }
    },
    "description" : "Smart monitor configuration of the zone."
}

Response 204

Disable Smart Monitor

DELETE

/v2_1/rkszones/{id}/smartMonitor

Use this API command to disable smart monitor for APs that belong to a zone.

Response 204

Modify Client Admission Control 2.4G

PATCH

/v2_1/rkszones/{id}/clientAdmissionControl24

Use this API command to modify the client admission control 2.4GHz radio configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "maxRadioLoadPercent" : 75,
    "minClientCount" : "10",
    "minClientThroughputMbps" : 0
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "maxRadioLoadPercent" : {
            "description" : "Maximum radio load percentage.",
            "type" : "integer",
            "default" : 75,
            "minimum" : 50,
            "maximum" : 100
        },
        "minClientCount" : {
            "description" : "Minimum client count number.",
            "type" : "integer",
            "default" : 10,
            "minimum" : 0,
            "maximum" : 100
        },
        "minClientThroughputMbps" : {
            "description" : "Minimum client throughput in Mbps.",
            "type" : "number",
            "default" : 0,
            "minimum" : 0,
            "maximum" : 100
        }
    },
    "description" : "AP client admission control 2.4GHz radio configuration of the zone."
}

Response 204

Disable Client Admission Control 2.4G

DELETE

/v2_1/rkszones/{id}/clientAdmissionControl24

Use this API command to disable client admission control 2.4GHz radio configuration for APs that belong to a zone.

Response 204

Modify Client Admission Control 5G

PATCH

/v2_1/rkszones/{id}/clientAdmissionControl50

Use this API command to modify the client admission control 5GHz radio configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "maxRadioLoadPercent" : 75,
    "minClientCount" : "10",
    "minClientThroughputMbps" : 0
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "maxRadioLoadPercent" : {
            "description" : "Maximum radio load percentage.",
            "type" : "integer",
            "default" : 75,
            "minimum" : 50,
            "maximum" : 100
        },
        "minClientCount" : {
            "description" : "Minimum client count number.",
            "type" : "integer",
            "default" : 10,
            "minimum" : 0,
            "maximum" : 100
        },
        "minClientThroughputMbps" : {
            "description" : "Minimum client throughput in Mbps.",
            "type" : "number",
            "default" : 0,
            "minimum" : 0,
            "maximum" : 100
        }
    },
    "description" : "AP client admission control 5GHz radio configuration of the zone."
}

Response 204

Disable Client Admission Control 5G

DELETE

/v2_1/rkszones/{id}/clientAdmissionControl50

Use this API command to disable client admission control 5GHz radio configuration for APs that belong to a zone.

Response 204

Modify Tunnel Profile

PATCH

/v2_1/rkszones/{id}/tunnelProfile

Use this API command to modify the tunnel profile for APs that belong to a zone.

RequestShowHide

Body

{
    "id" : "tunnelProfileId",
    "name" : "tunnelProfileName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Tunnel type configuration of the zone."
}

Response 204

Modify Background Scanning 2.4G

PATCH

/v2_1/rkszones/{id}/backgroundScanning24

Use this API command to modify the background scanning 2.4GHz radio configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "frequencyInSec" : 20
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "frequencyInSec" : {
            "description" : "Frequency in second",
            "type" : "integer",
            "minimum" : 1,
            "maximum" : 65535
        }
    },
    "description" : "Background scanning on 2.4GHz radio configuration of the zone."
}

Response 204

Disable Background Scanning 2.4G

DELETE

/v2_1/rkszones/{id}/backgroundScanning24

Use this API command to disable background scanning 2.4GHz radio configuration for APs that belong to a zone.

Response 204

Modify Background Scanning 5G

PATCH

/v2_1/rkszones/{id}/backgroundScanning50

Use this API command to modify the background scanning 5GHz radio configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "frequencyInSec" : 20
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "frequencyInSec" : {
            "description" : "Frequency in second",
            "type" : "integer",
            "minimum" : 1,
            "maximum" : 65535
        }
    },
    "description" : "Background scanning on 5GHz radio configuration of the zone."
}

Response 204

Disable Background Scanning 5G

DELETE

/v2_1/rkszones/{id}/backgroundScanning50

Use this API command to disable background scanning 5GHz radio configuration for APs that belong to a zone.

Response 204

Modify Client Load Balancing 2.4G

PATCH

/v2_1/rkszones/{id}/clientLoadBalancing24

Use this API command to modify the client load balancing 2.4GHz radio configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "adjacentRadioThreshold" : 12
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "adjacentRadioThreshold" : {
            "description" : "Adjacent radio threshold",
            "type" : "integer",
            "minimum" : 1,
            "maximum" : 100
        }
    },
    "description" : "Client load balancing on 2.4GHz radio configuration of the zone."
}

Response 204

Disable Client Load Balancing 2.4G

DELETE

/v2_1/rkszones/{id}/clientLoadBalancing24

Use this API command to disable client load balancing 2.4GHz radio configuration for APs that belong to a zone.

Response 204

Modify Client Load Balancing 5G

PATCH

/v2_1/rkszones/{id}/clientLoadBalancing50

Use this API command to modify the client load balancing 5GHz radio configuration for APs that belong to a zone.

RequestShowHide

Body

{
    "adjacentRadioThreshold" : 12
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "adjacentRadioThreshold" : {
            "description" : "Adjacent radio threshold",
            "type" : "integer",
            "minimum" : 1,
            "maximum" : 100
        }
    },
    "description" : "Client load balancing on 5GHz radio configuration of the zone."
}

Response 204

Disable Client Load Balancing 5G

DELETE

/v2_1/rkszones/{id}/clientLoadBalancing50

Use this API command to disable client load balancing 5GHz radio configuration for APs that belong to a zone.

Response 204

Modify Band Balancing

PATCH

/v2_1/rkszones/{id}/bandBalancing

Use this API command to modify band balancing for APs that belong to a zone.

RequestShowHide

Body

{
    "wifi24Percentage" : 10
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "wifi24Percentage" : {
            "description" : "Percentage of client load on 2.4GHz radio band",
            "type" : "integer",
            "minimum" : 0,
            "maximum" : 100
        }
    },
    "description" : "Band balancing configuration of the zone."
}

Response 204

Disable Band Balancing

DELETE

/v2_1/rkszones/{id}/bandBalancing

Use this API command to disable band balancing for APs that belong to a zone.

Response 204

Modify AP Reboot Timeout

PATCH

/v2_1/rkszones/{id}/apRebootTimeout

Use this API command to modify AP reboot timeout for APs that belong to a zone.

RequestShowHide

Body

{
    "gatewayLossTimeoutInSec" : 1800,
    "serverLossTimeoutInSec" : 7200
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "gatewayLossTimeoutInSec" : {
            "description" : "Gateway loss timeout in second",
            "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
        },
        "serverLossTimeoutInSec" : {
            "description" : "Server loss timeout in second",
            "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
        }
    },
    "description" : "AP reboot timeout of the zone."
}

Response 204

Modify Node Affinity Profile

PATCH

/v2_1/rkszones/{id}/nodeAffinityProfile

Use this API command to modify node affinity profile for APs that belong to a zone.

RequestShowHide

Body

{
    "id" : "nodeAffinityProfileId",
    "name" : "nodeAffinityProfileName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Node affinity profile of the zone."
}

Response 204

Modify Hotspot2.0 Venue Profile

PATCH

/v2_1/rkszones/{id}/venueProfile

Use this API command to modify Hotspot 2.0 venue profile for APs that belong to a zone.

RequestShowHide

Body

{
    "id" : "venueProfileId",
    "name" : "venueProfileName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Venue profile configuration of the zone."
}

Response 204

Clear Hotspot2.0 Venue Profile

DELETE

/v2_1/rkszones/{id}/venueProfile

Use this API command to clear Hotspot 2.0 venue profile for APs that belong to a zone.

Response 204

Modify Rogue

PATCH

/v2_1/rkszones/{id}/rogue

Use this API command to modify the rogue AP detection for APs that belong to a zone.

RequestShowHide

Body

{
    "reportType" : "All",
    "maliciousTypes" : null,
    "protectionEnabled" : true
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "reportType" : {
            "description" : "Report type",
            "enum" : [ "All", "Malicious" ]
        },
        "maliciousTypes" : {
            "description" : "Malicious type when reportType is Malicious",
            "type" : [ "array", "null" ],
            "items" : {
                "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
            }
        },
        "protectionEnabled" : {
            "description" : "Protection enabled",
            "type" : "boolean"
        }
    },
    "description" : "Rogue AP detection configuration of the zone."
}

Response 204

Disable Rogue

DELETE

/v2_1/rkszones/{id}/rogue

Use this API command to disable rogue AP detection for APs that belong to a zone.

Response 204

Modify Location Based Service

PATCH

/v2_1/rkszones/{id}/locationBasedService

Use this API command to modify location based service for APs that belong to a zone.

RequestShowHide

Body

{
    "id" : "lbsId",
    "name" : "lbsName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Location based service configuration of the zone."
}

Response 204

Disable Location Based Service

DELETE

/v2_1/rkszones/{id}/locationBasedService

Use this API command to disable location based service for APs that belong to a zone.

Response 204

Retrieve AP Model

GET

/v2_1/rkszones/{zoneId}/apmodel/{model}

Use this API command to retrieve AP model specific configuration that belong to a zone.

Response 200ShowHide

Body

{
    "ledStatusEnabled" : false,
    "lldp" : {
        "enabled" : true,
        "advertiseIntervalInSec" : 100,
        "holdTimeInSec" : 1000,
        "managementIPTLVEnabled" : false
    },
    "ledMode" : null,
    "internalHeaterEnabled" : null,
    "poeOutPortEnabled" : null,
    "poeModeSetting" : null,
    "usbPowerEnable" : null,
    "radioBand" : null,
    "externalAntenna24" : null,
    "externalAntenna50" : null,
    "lanPorts" : [ {
        "portName" : "LAN1",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 13,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Disable",
            "authenticator" : null,
            "supplicant" : null
        }
    }, {
        "portName" : "LAN2",
        "enabled" : true,
        "type" : "Access",
        "vlanUntagId" : 15,
        "members" : "15",
        "_8021X" : {
            "type" : "MACBasedAuthenticator",
            "authenticator" : {
                "authentication" : {
                    "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                    "name" : "zoneRadius"
                },
                "accounting" : {
                    "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                    "name" : "zoneRadiusAcct"
                },
                "macAuthByPassEnabled" : true
            },
            "supplicant" : null
        }
    }, {
        "portName" : "LAN3",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 1,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Supplicant",
            "authenticator" : null,
            "supplicant" : {
                "type" : "Custom",
                "userName" : "a",
                "password" : "a"
            }
        }
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "ledStatusEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "lldp" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "advertiseIntervalInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 1,
                    "maximum" : 300
                },
                "holdTimeInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 60,
                    "maximum" : 1200
                },
                "managementIPTLVEnabled" : {
                    "type" : [ "boolean", "null" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "ledMode" : {
            "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
        },
        "internalHeaterEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeOutPortEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeModeSetting" : {
            "enum" : [ null, "Auto", "_802_3af" ]
        },
        "usbPowerEnable" : {
            "type" : [ "boolean", "null" ]
        },
        "radioBand" : {
            "enum" : [ null, "2.4GHz", "5GHz" ]
        },
        "externalAntenna24" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "externalAntenna50" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "lanPorts" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "portName" : {
                        "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                    },
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "type" : {
                        "enum" : [ null, "Access", "Trunk", "General" ]
                    },
                    "vlanUntagId" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 4094
                    },
                    "members" : {
                        "type" : [ "string", "null" ]
                    },
                    "_8021X" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                            },
                            "authenticator" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "authentication" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "accounting" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "macAuthByPassEnabled" : {
                                        "type" : "boolean"
                                    }
                                },
                                "required" : [ "authentication", "macAuthByPassEnabled" ]
                            },
                            "supplicant" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "enum" : [ "MACAddress", "Custom" ]
                                    },
                                    "userName" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                    },
                                    "password" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                    }
                                },
                                "required" : [ "type" ]
                            }
                        },
                        "required" : [ "type" ]
                    }
                },
                "required" : [ "portName", "enabled" ]
            }
        }
    }
}

Modify AP Model

PUT

/v2_1/rkszones/{zoneId}/apmodel/{model}

Use this API command to modify the AP model specific configuration that belong to a zone.

RequestShowHide

Body

{
    "ledStatusEnabled" : false,
    "lldp" : {
        "enabled" : true,
        "advertiseIntervalInSec" : 100,
        "holdTimeInSec" : 1000,
        "managementIPTLVEnabled" : false
    },
    "ledMode" : null,
    "internalHeaterEnabled" : null,
    "poeOutPortEnabled" : null,
    "poeModeSetting" : null,
    "usbPowerEnable" : null,
    "radioBand" : null,
    "externalAntenna24" : null,
    "externalAntenna50" : null,
    "lanPorts" : [ {
        "portName" : "LAN1",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 13,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Disable",
            "authenticator" : null,
            "supplicant" : null
        }
    }, {
        "portName" : "LAN2",
        "enabled" : true,
        "type" : "Access",
        "vlanUntagId" : 15,
        "members" : "15",
        "_8021X" : {
            "type" : "MACBasedAuthenticator",
            "authenticator" : {
                "authentication" : {
                    "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                    "name" : "zoneRadius"
                },
                "accounting" : {
                    "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                    "name" : "zoneRadiusAcct"
                },
                "macAuthByPassEnabled" : true
            },
            "supplicant" : null
        }
    }, {
        "portName" : "LAN3",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 1,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Supplicant",
            "authenticator" : null,
            "supplicant" : {
                "type" : "Custom",
                "userName" : "a",
                "password" : "a"
            }
        }
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "ledStatusEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "lldp" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "advertiseIntervalInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 1,
                    "maximum" : 300
                },
                "holdTimeInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 60,
                    "maximum" : 1200
                },
                "managementIPTLVEnabled" : {
                    "type" : [ "boolean", "null" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "ledMode" : {
            "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
        },
        "internalHeaterEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeOutPortEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeModeSetting" : {
            "enum" : [ null, "Auto", "_802_3af" ]
        },
        "usbPowerEnable" : {
            "type" : [ "boolean", "null" ]
        },
        "radioBand" : {
            "enum" : [ null, "2.4GHz", "5GHz" ]
        },
        "externalAntenna24" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "externalAntenna50" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "lanPorts" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "portName" : {
                        "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                    },
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "type" : {
                        "enum" : [ null, "Access", "Trunk", "General" ]
                    },
                    "vlanUntagId" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 4094
                    },
                    "members" : {
                        "type" : [ "string", "null" ]
                    },
                    "_8021X" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                            },
                            "authenticator" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "authentication" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "accounting" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "macAuthByPassEnabled" : {
                                        "type" : "boolean"
                                    }
                                },
                                "required" : [ "authentication", "macAuthByPassEnabled" ]
                            },
                            "supplicant" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "enum" : [ "MACAddress", "Custom" ]
                                    },
                                    "userName" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                    },
                                    "password" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                    }
                                },
                                "required" : [ "type" ]
                            }
                        },
                        "required" : [ "type" ]
                    }
                },
                "required" : [ "portName", "enabled" ]
            }
        }
    }
}

Response 204

Modify Radio 2.4G Auto ChannelSelectMode

PATCH

/v2_1/rkszones/{id}/autoChannelSelection24

Modify Radio 2.4G Auto ChannelSelectMode of a zone

RequestShowHide

Body

{
    "channelSelectMode" : "ChannelFly"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "channelSelectMode" : {
            "description" : "Channel Select Mode",
            "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
        }
    },
    "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
}

Response 204

Modify Radio 5G Auto ChannelSelectMode

PATCH

/v2_1/rkszones/{id}/autoChannelSelection50

Modify Radio 5G Auto ChannelSelectMode of a zone

RequestShowHide

Body

{
    "channelSelectMode" : "BackgroundScanning"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "channelSelectMode" : {
            "description" : "Channel Select Mode",
            "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
        }
    },
    "description" : "client load balancing on Radio 5G, auto channel selection mode"
}

Response 204

Modify IPsec Profile

PATCH

/v2_1/rkszones/{id}/ipsecProfile

Modify IPsec Profile of a zone

RequestShowHide

Body

{
    "id" : "ipsecProfileId",
    "name" : "ipsecProfileName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "ipsec profile configuration of the Zone."
}

Response 204

Delete

DELETE

/v2_1/rkszones/{id}

Use this API command to delete a zone.

Response 204

AP Group

Retrieve List

GET

/v2_1/rkszones/{zoneId}/apgroups

Use this API command to retrieve the list of AP groups that belong to a zone.

Parameters
index
number (optional)
The index of the first entry to be retrieved. Default: 0

listSize
number (optional)
The maximum number of entries to be retrieved. Default: 100

Response 200ShowHide

Body

{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "id" : "apGroupUUID",
        "name" : "apGroupName"
    }, {
        "id" : "apGroupUUID2",
        "name" : "apGroupName2"
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the AP group",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Description of the AP group",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve

GET

/v2_1/rkszones/{zoneId}/apgroups/{id}

Use this API command to retrieve information about an AP group.

Response 200ShowHide

Body

{
    "id" : "apGroupUUID",
    "zoneId" : "zoneUUID",
    "name" : "apGroupName",
    "description" : "apGroupDescription",
    "location" : "test-ap1_modify",
    "locationAdditionalInfo" : "add",
    "latitude" : 34,
    "longitude" : 45,
    "wifi24" : {
        "txPower" : "Full",
        "channelWidth" : 0,
        "channel" : 11
    },
    "wifi50" : null,
    "wlanGroup24" : {
        "id" : "19b10850-7eaa-11e4-a584-08002716c79f",
        "name" : "default"
    },
    "wlanGroup50" : null,
    "locationBasedService" : null,
    "clientAdmissionControl24" : {
        "maxRadioLoadPercent" : 70,
        "minClientCount" : 30,
        "minClientThroughputMbps" : 10.0,
        "enabled" : true
    },
    "clientAdmissionControl50" : null,
    "venueProfile" : null,
    "members" : [ {
        "apMac" : "00:11:22:33:44:55"
    }, {
        "apMac" : "11:22:33:44:55:66"
    } ],
    "autoChannelSelection24" : {
        "channelSelectMode" : "ChannelFly"
    },
    "autoChannelSelection50" : {
        "channelSelectMode" : "BackgroundScanning"
    },
    "channelEvaluationInterval" : 777
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the AP group",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP group belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP group",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the AP group",
            "type" : "string"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP group."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the AP group."
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP group"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP group"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width (only 20 is currently supported)",
                    "enum" : [ 20 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
                }
            },
            "description" : "AP 2.4GHz radio configuration of the AP group."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40, 80 ]
                },
                "indoorChannel" : {
                    "description" : "Indoor channel number",
                    "enum" : [ 0, 36, 40, 44, 48, 149, 153, 157, 161 ]
                },
                "outdoorChannel" : {
                    "description" : "Outdoor channel number",
                    "enum" : [ 0, 149, 153, 157, 161 ]
                }
            },
            "description" : "AP 5GHz radio configuration of the AP group."
        },
        "wlanGroup24" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level."
        },
        "wlanGroup50" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level."
        },
        "locationBasedService" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the AP group."
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Venue profile configuration of the AP group."
        },
        "members" : {
            "description" : "Members of the AP group",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "apMac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                        "description" : "MAC address of member AP"
                    }
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                }
            },
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the ap group",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        }
    },
    "required" : [ "name" ]
}

Create

POST

/v2_1/rkszones/{zoneId}/apgroups

Use this API command to create new AP group within a zone.

RequestShowHide

Body

{
    "name" : "apGroupName",
    "description" : "apGroupDescription"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the AP group"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the AP group"
        }
    },
    "required" : [ "name" ]
}

Response 201ShowHide

Body

{
    "id" : "apGroupUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the AP group",
            "type" : "string"
        }
    }
}

Modify Basic

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}

Use this API command to modify the basic information of an AP group.

RequestShowHide

Body

{
    "name" : "apGroupNameModified",
    "description" : "apGroupDescriptionModified",
    "location" : "test-ap1_modify",
    "locationAdditionalInfo" : "add",
    "latitude" : 34,
    "longitude" : 45,
    "channelEvaluationInterval" : 777
}

Schema

{
    "name" : {
        "type" : "string",
        "minLength" : 2,
        "maxLength" : 32,
        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
        "description" : "Name of the AP group"
    },
    "description" : {
        "type" : [ "string", "null" ],
        "maxLength" : 64,
        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Description of the AP group"
    },
    "location" : {
        "type" : "string",
        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Location of the AP group."
    },
    "locationAdditionalInfo" : {
        "type" : "string",
        "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
        "description" : "Location additional info of the AP group."
    },
    "latitude" : {
        "type" : "number",
        "description" : "Latitude coordinate (in decimal format) of the AP group"
    },
    "longitude" : {
        "type" : "number",
        "description" : "Longitude coordinate (in decimal format) of the AP group"
    },
    "channelEvaluationInterval" : {
        "description" : "channel evaluation Interval of the ap group",
        "type" : "integer",
        "default" : 600,
        "minimum" : 60,
        "maximum" : 3600
    }
}

Response 204

Disable Location Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/location

Use this API command to disable location override for APs that belong to an AP group.

Response 204

Disable Location AdditionalInfo Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo

Use this API command to disable location additionalInfo override zone for APs that belong to an AP group.

Response 204

Modify Radio 2.4G Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/wifi24

Use this API command to modify the 2.4GHz radio configuration override zone for APs that belong to an AP group.

RequestShowHide

Body

{
    "txPower" : "Full",
    "channelWidth" : 0,
    "channel" : 11
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "txPower" : {
            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
            "description" : "Transmission power"
        },
        "channelWidth" : {
            "description" : "Channel width (only 20 is currently supported)",
            "enum" : [ 20 ]
        },
        "channel" : {
            "description" : "Channel number",
            "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
        }
    },
    "description" : "AP 2.4GHz radio configuration of the AP group."
}

Response 204

Disable Radio 2.4G Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/wifi24

Use this API command to disable 2.4GHz radio configuration override zone for APs that belong to an AP group.

Response 204

Modify Radio 5G Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/wifi50

Use this API command to modify the 5GHz radio configuration override zone for APs that belong to an AP group.

RequestShowHide

Body

{
    "txPower" : "Full",
    "channelWidth" : 40,
    "indoorChannel" : 0,
    "outdoorChannel" : 0
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "txPower" : {
            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
            "description" : "Transmission power"
        },
        "channelWidth" : {
            "description" : "Channel width. Zero (0) means Auto.",
            "enum" : [ 0, 20, 40, 80 ]
        },
        "indoorChannel" : {
            "description" : "Indoor channel number",
            "enum" : [ 0, 36, 40, 44, 48, 149, 153, 157, 161 ]
        },
        "outdoorChannel" : {
            "description" : "Outdoor channel number",
            "enum" : [ 0, 149, 153, 157, 161 ]
        }
    },
    "description" : "AP 5GHz radio configuration of the AP group."
}

Response 204

Disable Radio 5G Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/wifi50

Use this API command to disable 5GHz radio configuration override zone for APs that belong to an AP group.

Response 204

Modify WLAN group 2.4G Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24

Use this API command to modify the WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.

RequestShowHide

Body

{
    "id" : "19b10850-7eaa-11e4-a584-08002716c79f",
    "name" : "default"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level."
}

Response 204

Disable WLAN group 2.4G Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24

Use this API command to disable WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.

Response 204

Modify WLAN group 5G Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50

Use this API command to modify the WLAN group on 5GHz radio override zone for APs that belong to an AP group.

RequestShowHide

Body

{
    "id" : "19b10850-7eaa-11e4-a584-08002716c79f",
    "name" : "default"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level."
}

Response 204

Disable WLAN group 5G Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50

Use this API command to disable WLAN group on 5GHz radio override zone for APs that belong to an AP group.

Response 204

Modify Location Based Service Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService

Use this API command to modify location based service override zone for APs that belong to an AP group.

RequestShowHide

Body

{
    "id" : "lbsServiceId",
    "name" : "lbsServiceName"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "enabled" : {
            "type" : "boolean"
        },
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Location based service configuration of the AP group."
}

Response 204

Disable Location Based Service Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService

Use this API command to disable location based service override zone for APs that belong to an AP group.

Response 204

Modify Client Admission Control 2.4G Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24

Use this API command to modify client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.

RequestShowHide

Body

{
    "maxRadioLoadPercent" : 70,
    "minClientCount" : 30,
    "minClientThroughputMbps" : 10.0,
    "enabled" : true
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "enabled" : {
            "type" : "boolean"
        },
        "maxRadioLoadPercent" : {
            "description" : "Maximum radio load percentage.",
            "type" : "integer",
            "default" : 75,
            "minimum" : 50,
            "maximum" : 100
        },
        "minClientCount" : {
            "description" : "Minimum client count number.",
            "type" : "integer",
            "default" : 10,
            "minimum" : 0,
            "maximum" : 100
        },
        "minClientThroughputMbps" : {
            "description" : "Minimum client throughput in Mbps.",
            "type" : "number",
            "default" : 0,
            "minimum" : 0,
            "maximum" : 100
        }
    },
    "description" : "AP client admission control of 2.4GHz radio configuration of the AP group."
}

Response 204

Disable Client Admission Control 2.4G Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24

Use this API command to disable client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.

Response 204

Modify Client Admission Control 5G Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50

Use this API command to modify client admission control 5GHz radio configuration override zone for APs that belong to an AP group.

RequestShowHide

Body

{
    "maxRadioLoadPercent" : 70,
    "minClientCount" : 30,
    "minClientThroughputMbps" : 10.0,
    "enabled" : true
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "enabled" : {
            "type" : "boolean"
        },
        "maxRadioLoadPercent" : {
            "description" : "Maximum radio load percentage.",
            "type" : "integer",
            "default" : 75,
            "minimum" : 50,
            "maximum" : 100
        },
        "minClientCount" : {
            "description" : "Minimum client count number.",
            "type" : "integer",
            "default" : 10,
            "minimum" : 0,
            "maximum" : 100
        },
        "minClientThroughputMbps" : {
            "description" : "Minimum client throughput in Mbps.",
            "type" : "number",
            "default" : 0,
            "minimum" : 0,
            "maximum" : 100
        }
    },
    "description" : "AP client admission control of 5GHz radio configuration of the AP group."
}

Response 204

Disable Client Admission Control 5G Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50

Use this API command to disable client admission control 5GHz radio configuration override zone for APs that belong to an AP group.

Response 204

Modify Hotspot2.0 Venue Profile

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/venueProfile

Use this API command to modify Hotspot 2.0 venue profile for APs that belong to an AP group.

RequestShowHide

Body

{
    "id" : "venueProfileId",
    "name" : "venueProfileName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Venue profile configuration of the AP group."
}

Response 204

Clear Hotspot2.0 Venue Profile

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/venueProfile

Use this API command to clear Hotspot 2.0 venue profile for APs that belong to an AP group.

Response 204

Add Member

POST

/v2_1/rkszones/{zoneId}/apgroups/{id}/members/{apMac}

Use this API command to add a member AP to an AP group.

Response 201

Remove Member

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/members/{apMac}

Use this API command to remove a member AP from an AP group.

Response 204

Retrieve AP Model

GET

/v2_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

Use this API command to retrieve AP model specific configuration override zone that belong to an AP group, empty mean not override zone.

Response 200ShowHide

Body

{
    "ledStatusEnabled" : false,
    "lldp" : {
        "enabled" : true,
        "advertiseIntervalInSec" : 100,
        "holdTimeInSec" : 1000,
        "managementIPTLVEnabled" : false
    },
    "ledMode" : null,
    "internalHeaterEnabled" : null,
    "poeOutPortEnabled" : null,
    "poeModeSetting" : null,
    "usbPowerEnable" : null,
    "radioBand" : null,
    "externalAntenna24" : null,
    "externalAntenna50" : null,
    "lanPorts" : [ {
        "portName" : "LAN1",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 13,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Disable",
            "authenticator" : null,
            "supplicant" : null
        }
    }, {
        "portName" : "LAN2",
        "enabled" : true,
        "type" : "Access",
        "vlanUntagId" : 15,
        "members" : "15",
        "_8021X" : {
            "type" : "MACBasedAuthenticator",
            "authenticator" : {
                "authentication" : {
                    "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                    "name" : "zoneRadius"
                },
                "accounting" : {
                    "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                    "name" : "zoneRadiusAcct"
                },
                "macAuthByPassEnabled" : true
            },
            "supplicant" : null
        }
    }, {
        "portName" : "LAN3",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 1,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Supplicant",
            "authenticator" : null,
            "supplicant" : {
                "type" : "Custom",
                "userName" : "a",
                "password" : "a"
            }
        }
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "ledStatusEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "lldp" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "advertiseIntervalInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 1,
                    "maximum" : 300
                },
                "holdTimeInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 60,
                    "maximum" : 1200
                },
                "managementIPTLVEnabled" : {
                    "type" : [ "boolean", "null" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "ledMode" : {
            "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
        },
        "internalHeaterEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeOutPortEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeModeSetting" : {
            "enum" : [ null, "Auto", "_802_3af" ]
        },
        "usbPowerEnable" : {
            "type" : [ "boolean", "null" ]
        },
        "radioBand" : {
            "enum" : [ null, "2.4GHz", "5GHz" ]
        },
        "externalAntenna24" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "externalAntenna50" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "lanPorts" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "portName" : {
                        "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                    },
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "type" : {
                        "enum" : [ null, "Access", "Trunk", "General" ]
                    },
                    "vlanUntagId" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 4094
                    },
                    "members" : {
                        "type" : [ "string", "null" ]
                    },
                    "_8021X" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                            },
                            "authenticator" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "authentication" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "accounting" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "macAuthByPassEnabled" : {
                                        "type" : "boolean"
                                    }
                                },
                                "required" : [ "authentication", "macAuthByPassEnabled" ]
                            },
                            "supplicant" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "enum" : [ "MACAddress", "Custom" ]
                                    },
                                    "userName" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                    },
                                    "password" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                    }
                                },
                                "required" : [ "type" ]
                            }
                        },
                        "required" : [ "type" ]
                    }
                },
                "required" : [ "portName", "enabled" ]
            }
        }
    }
}

Override AP Model

PUT

/v2_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

Use this API command to modify AP model specific configuration override zone that belong to an AP group.

RequestShowHide

Body

{
    "ledStatusEnabled" : false,
    "lldp" : {
        "enabled" : true,
        "advertiseIntervalInSec" : 100,
        "holdTimeInSec" : 1000,
        "managementIPTLVEnabled" : false
    },
    "ledMode" : null,
    "internalHeaterEnabled" : null,
    "poeOutPortEnabled" : null,
    "poeModeSetting" : null,
    "usbPowerEnable" : null,
    "radioBand" : null,
    "externalAntenna24" : null,
    "externalAntenna50" : null,
    "lanPorts" : [ {
        "portName" : "LAN1",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 13,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Disable",
            "authenticator" : null,
            "supplicant" : null
        }
    }, {
        "portName" : "LAN2",
        "enabled" : true,
        "type" : "Access",
        "vlanUntagId" : 15,
        "members" : "15",
        "_8021X" : {
            "type" : "MACBasedAuthenticator",
            "authenticator" : {
                "authentication" : {
                    "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                    "name" : "zoneRadius"
                },
                "accounting" : {
                    "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                    "name" : "zoneRadiusAcct"
                },
                "macAuthByPassEnabled" : true
            },
            "supplicant" : null
        }
    }, {
        "portName" : "LAN3",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 1,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Supplicant",
            "authenticator" : null,
            "supplicant" : {
                "type" : "Custom",
                "userName" : "a",
                "password" : "a"
            }
        }
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "ledStatusEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "lldp" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "advertiseIntervalInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 1,
                    "maximum" : 300
                },
                "holdTimeInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 60,
                    "maximum" : 1200
                },
                "managementIPTLVEnabled" : {
                    "type" : [ "boolean", "null" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "ledMode" : {
            "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
        },
        "internalHeaterEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeOutPortEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeModeSetting" : {
            "enum" : [ null, "Auto", "_802_3af" ]
        },
        "usbPowerEnable" : {
            "type" : [ "boolean", "null" ]
        },
        "radioBand" : {
            "enum" : [ null, "2.4GHz", "5GHz" ]
        },
        "externalAntenna24" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "externalAntenna50" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "lanPorts" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "portName" : {
                        "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                    },
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "type" : {
                        "enum" : [ null, "Access", "Trunk", "General" ]
                    },
                    "vlanUntagId" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 4094
                    },
                    "members" : {
                        "type" : [ "string", "null" ]
                    },
                    "_8021X" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                            },
                            "authenticator" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "authentication" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "accounting" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "macAuthByPassEnabled" : {
                                        "type" : "boolean"
                                    }
                                },
                                "required" : [ "authentication", "macAuthByPassEnabled" ]
                            },
                            "supplicant" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "enum" : [ "MACAddress", "Custom" ]
                                    },
                                    "userName" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                    },
                                    "password" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                    }
                                },
                                "required" : [ "type" ]
                            }
                        },
                        "required" : [ "type" ]
                    }
                },
                "required" : [ "portName", "enabled" ]
            }
        }
    }
}

Response 204

Disable Override AP Model

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

Use this API command to disable AP model specific configuration override zone that belong to an AP group.

Response 204

Modify Radio 2.4G Auto ChannelSelectMode Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24

Override Radio 2.4G Auto ChannelSelectMode of an AP group

RequestShowHide

Body

{
    "channelSelectMode" : "ChannelFly"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "channelSelectMode" : {
            "description" : "Channel Select Mode",
            "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
        }
    },
    "description" : "client load balancing on Radio 2.4G, auto channel selection mode"
}

Response 204

Modify Radio 5G Auto ChannelSelectMode Override

PATCH

/v2_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50

Override Radio 5G Auto ChannelSelectMode of an AP group

RequestShowHide

Body

{
    "channelSelectMode" : "BackgroundScanning"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "channelSelectMode" : {
            "description" : "Channel Select Mode",
            "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
        }
    },
    "description" : "client load balancing on Radio 5G, auto channel selection mode"
}

Response 204

Disable Radio 2.4G Auto ChannelSelectMode Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24

Disable Radio 2.4G Auto ChannelSelectMode Override of an AP group

Response 204

Disable Radio 5G Auto ChannelSelectMode Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50

Disable Radio 5G Auto ChannelSelectMode Override of an AP group

Response 204

Disable Channel Evaluation Interval Override

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}/channelEvaluationInterval

Disable Channel Evaluation Interval Override of an AP group

Response 204

Delete

DELETE

/v2_1/rkszones/{zoneId}/apgroups/{id}

Use this API command to delete an AP group.

Response 204

Access Point Configuration

Retrieve List

GET

/v2_1/aps

Use this API command to retrieve the list of APs that belong to a zone or a domain.

Parameters
index
number (optional)
The index of the first entry to be retrieved. Default: 0

listSize
number (optional)
The maximum number of entries to be retrieved. Default: 100

zoneId
string (optional)
filter AP list by zone

domainId
string (optional)
filter AP list by domain. Default: current logon domain

Response 200ShowHide

Body

{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "mac" : "00:11:22:33:44:55",
        "zoneId" : "zoneUUID",
        "apGroupId" : "apGroupUUID",
        "name" : "apName"
    }, {
        "mac" : "11:22:33:44:55:66",
        "zoneId" : "zoneUUID2",
        "apGroupId" : "apGroupUUID2",
        "name" : "apName2"
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "description" : "Total AP count",
            "type" : "integer"
        },
        "hasMore" : {
            "description" : "Indicates whether there are more APs after the list that is currently displayed",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first AP returned out of the complete AP list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "mac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                        "description" : "MAC address of the AP"
                    },
                    "zoneId" : {
                        "description" : "Identifier of the zone to which the AP belongs",
                        "type" : "string"
                    },
                    "apGroupId" : {
                        "description" : "Identifier of the AP group to which the AP belongs",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the AP",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve

GET

/v2_1/aps/{apMac}

Use this API command to retrieve the configuration of an AP.

Response 200ShowHide

Body

{
    "zoneId" : "zoneUUID",
    "apGroupId" : "apGroupUUID",
    "serial" : "00000096",
    "model" : "ZF7343",
    "name" : "apName",
    "latitude" : 22.3,
    "longitude" : 114,
    "location" : "location",
    "description" : "apDescription",
    "administrativeState" : "Unlocked",
    "provisionChecklist" : "provisionChecklist",
    "login" : {
        "apLoginName" : "apLoginName",
        "apLoginPassword" : "apLoginPassword"
    },
    "wifi24" : {
        "txPower" : "txPower",
        "channelWidth" : 1,
        "channel" : 13
    },
    "wifi50" : {
        "txPower" : "txPower",
        "channelWidth" : 1,
        "channel" : 1
    },
    "wlanGroup24" : {
        "id" : "wlanGroupUUID",
        "name" : "wlanGroupName"
    },
    "wlanGroup50" : {
        "id" : "wlanGroupUUID",
        "name" : "wlanGroupName"
    },
    "network" : {
        "ipType" : "Static",
        "ip" : "1.1.1.1",
        "netmask" : "255.255.255.0",
        "gateway" : "1.1.1.0",
        "primaryDns" : "8.8.8.8",
        "secondaryDns" : "8.8.8.9"
    },
    "smartMonitor" : {
        "enabled" : true,
        "intervalInSec" : 10,
        "retryThreshold" : 10
    },
    "bonjourGateway" : {
        "id" : "bonjourGatewayUUID",
        "name" : "bonjourGatewayName"
    },
    "specific" : {
        "ledStatusEnabled" : false,
        "lldp" : {
            "enabled" : true,
            "advertiseIntervalInSec" : 100,
            "holdTimeInSec" : 1000,
            "managementIPTLVEnabled" : false
        },
        "ledMode" : null,
        "internalHeaterEnabled" : null,
        "poeOutPortEnabled" : null,
        "poeModeSetting" : null,
        "usbPowerEnable" : null,
        "radioBand" : null,
        "externalAntenna24" : null,
        "externalAntenna50" : null,
        "lanPorts" : [ {
            "portName" : "LAN1",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 13,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Disable",
                "authenticator" : null,
                "supplicant" : null
            }
        }, {
            "portName" : "LAN2",
            "enabled" : true,
            "type" : "Access",
            "vlanUntagId" : 15,
            "members" : "15",
            "_8021X" : {
                "type" : "MACBasedAuthenticator",
                "authenticator" : {
                    "authentication" : {
                        "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                        "name" : "zoneRadius"
                    },
                    "accounting" : {
                        "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                        "name" : "zoneRadiusAcct"
                    },
                    "macAuthByPassEnabled" : true
                },
                "supplicant" : null
            }
        }, {
            "portName" : "LAN3",
            "enabled" : true,
            "type" : "Trunk",
            "vlanUntagId" : 1,
            "members" : "1-4094",
            "_8021X" : {
                "type" : "Supplicant",
                "authenticator" : null,
                "supplicant" : {
                    "type" : "Custom",
                    "userName" : "a",
                    "password" : "a"
                }
            }
        } ]
    },
    "channelEvaluationInterval" : 777
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
            "description" : "MAC address of the AP"
        },
        "zoneId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
            "description" : "Name of the AP"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the AP"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP. It is a text description to indicate the location of the AP."
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP."
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "enum" : [ "Locked", "Unlocked" ],
            "default" : "Unlocked"
        },
        "wlanService24Enabled" : {
            "description" : "WLAN service enabled or disabled on 2.4GHz radio",
            "type" : "boolean"
        },
        "wlanService50Enabled" : {
            "description" : "WLAN service enabled or disabled on 5GHz radio",
            "type" : "boolean"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
                    "description" : "User name of the AP administrator"
                },
                "apLoginPassword" : {
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
                    "description" : "Password of the AP administrator"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ],
            "description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level."
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Indicates whether syslog is enabled or disabled",
                    "type" : "boolean"
                },
                "address" : {
                    "type" : "string",
                    "description" : "Address of the syslog server. If syslog is enabled, this attribute is required."
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : "514",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            },
            "required" : [ "enabled" ],
            "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level."
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "Transmission power"
                },
                "channelWidth" : {
                    "description" : "Channel width (only 20 is currently supported)",
                    "enum" : [ 20 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
                }
            },
            "description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level."
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "txPower" : {
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "description" : "transmission power"
                },
                "channelWidth" : {
                    "description" : "channel width, 0 mean Auto",
                    "enum" : [ 0, 20, 40, 80 ]
                },
                "channel" : {
                    "description" : "channel number",
                    "enum" : [ 0, 36, 40, 44, 48, 149, 153, 157, 161 ]
                }
            },
            "description" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level."
        },
        "wlanGroup24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            },
            "description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level."
        },
        "wlanGroup50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            },
            "description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level."
        },
        "network" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "enum" : [ "Static", "Dynamic", "Keep" ]
                },
                "ip" : {
                    "type" : "string",
                    "description" : "IP address of the AP"
                },
                "netmask" : {
                    "type" : "string",
                    "pattern" : "(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
                    "description" : "Netmask of the AP's subnet"
                },
                "gateway" : {
                    "type" : "string",
                    "description" : "Gateway of the AP"
                },
                "primaryDns" : {
                    "type" : "string",
                    "description" : "Primary DNS server address of the AP"
                },
                "secondaryDns" : {
                    "type" : "string",
                    "description" : "Secondary DNS server address of the AP"
                }
            },
            "description" : "Network settings of the AP."
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            },
            "description" : "Smart monitor of the AP."
        },
        "bonjourGateway" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour gateway of the AP."
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Client admission control configuration of 2.4GHz radio of the AP."
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            },
            "description" : "Client admission control configuration of 5GHz radio of the AP."
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Venue profile configuration of the AP."
        },
        "specific" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ledStatusEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "lldp" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "advertiseIntervalInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 1,
                            "maximum" : 300
                        },
                        "holdTimeInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 60,
                            "maximum" : 1200
                        },
                        "managementIPTLVEnabled" : {
                            "type" : [ "boolean", "null" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "ledMode" : {
                    "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
                },
                "internalHeaterEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "poeOutPortEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "poeModeSetting" : {
                    "enum" : [ null, "Auto", "_802_3af" ]
                },
                "usbPowerEnable" : {
                    "type" : [ "boolean", "null" ]
                },
                "radioBand" : {
                    "enum" : [ null, "2.4GHz", "5GHz" ]
                },
                "externalAntenna24" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "dbi" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 90
                        },
                        "chainMask" : {
                            "enum" : [ null, "Two", "Three" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "externalAntenna50" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "dbi" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 90
                        },
                        "chainMask" : {
                            "enum" : [ null, "Two", "Three" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "lanPorts" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "portName" : {
                                "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                            },
                            "enabled" : {
                                "type" : "boolean"
                            },
                            "type" : {
                                "enum" : [ null, "Access", "Trunk", "General" ]
                            },
                            "vlanUntagId" : {
                                "type" : [ "integer", "null" ],
                                "minimum" : 0,
                                "maximum" : 4094
                            },
                            "members" : {
                                "type" : [ "string", "null" ]
                            },
                            "_8021X" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                                    },
                                    "authenticator" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "authentication" : {
                                                "type" : [ "object", "null" ],
                                                "additionalProperties" : false,
                                                "properties" : {
                                                    "id" : {
                                                        "type" : "string"
                                                    },
                                                    "name" : {
                                                        "type" : "string"
                                                    }
                                                }
                                            },
                                            "accounting" : {
                                                "type" : [ "object", "null" ],
                                                "additionalProperties" : false,
                                                "properties" : {
                                                    "id" : {
                                                        "type" : "string"
                                                    },
                                                    "name" : {
                                                        "type" : "string"
                                                    }
                                                }
                                            },
                                            "macAuthByPassEnabled" : {
                                                "type" : "boolean"
                                            }
                                        },
                                        "required" : [ "authentication", "macAuthByPassEnabled" ]
                                    },
                                    "supplicant" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "type" : {
                                                "enum" : [ "MACAddress", "Custom" ]
                                            },
                                            "userName" : {
                                                "type" : [ "string", "null" ],
                                                "maxLength" : 64,
                                                "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                            },
                                            "password" : {
                                                "type" : [ "string", "null" ],
                                                "maxLength" : 64,
                                                "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                            }
                                        },
                                        "required" : [ "type" ]
                                    }
                                },
                                "required" : [ "type" ]
                            }
                        },
                        "required" : [ "portName", "enabled" ]
                    }
                }
            },
            "description" : "Model specific configuration of the AP"
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the AP",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        }
    }
}

Retrieve AP Picture

GET

/v2_1/aps/{apMac}/picture

Use this API command to retrieve the current AP picture.

Response 200ShowHide
Body
```
Binary data for the picture
```

Create

POST

/v2_1/aps

Use this API command to create a new access point.

RequestShowHide

Body

{
    "mac" : "00:11:22:33:44:55",
    "zoneId" : "zoneUUID",
    "apGroupId" : "apGroupUUID",
    "serial" : "00000096",
    "model" : "ZF7962",
    "name" : "apName",
    "latitude" : 22.3,
    "longitude" : 114,
    "location" : "shenzhen",
    "description" : "apDescription",
    "administrativeState" : "Unlocked",
    "provisionChecklist" : "test"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
            "description" : "MAC address of the AP"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs. If the AP belongs to the default AP group, this property is not needed.",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
            "description" : "Name of the AP"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP. This is a free format text description that indicates the location of the AP."
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the AP"
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "enum" : [ "Locked", "Unlocked" ],
            "default" : "Unlocked"
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        }
    },
    "required" : [ "mac", "zoneId" ]
}

Response 201

Modify Basic

PATCH

/v2_1/aps/{apMac}

Use this API command to modify the basic information of an AP.

RequestShowHide

Body

{
    "zoneId" : "zoneUUID",
    "apGroupId" : "apGroupUUID",
    "serial" : "00000096",
    "model" : "ZF7343",
    "name" : "apName",
    "latitude" : 22.3,
    "longitude" : 114,
    "location" : "location",
    "locationAdditionalInfo" : "locationAdditionalInfo",
    "description" : "apDescription",
    "administrativeState" : "Unlocked",
    "provisionChecklist" : "provisionChecklist",
    "wlanService24Enabled" : true,
    "wlanService50Enabled" : null,
    "channelEvaluationInterval" : 777
}

Schema

{
    "zoneId" : {
        "description" : "Identifier of the zone to which the AP belongs",
        "type" : "string"
    },
    "apGroupId" : {
        "description" : "Identifier of the AP group to which the AP belongs",
        "type" : "string"
    },
    "serial" : {
        "description" : "Serial number of the AP",
        "type" : "string"
    },
    "model" : {
        "description" : "Model name of the AP",
        "type" : "string"
    },
    "name" : {
        "type" : "string",
        "minLength" : 2,
        "maxLength" : 64,
        "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
        "description" : "Name of the AP"
    },
    "latitude" : {
        "type" : "number",
        "description" : "Latitude coordinate (in decimal format) of the AP"
    },
    "longitude" : {
        "type" : "number",
        "description" : "Longitude coordinate (in decimal format) of the AP"
    },
    "location" : {
        "type" : "string",
        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Location of the AP. This is a text description that indicates the location of the AP."
    },
    "locationAdditionalInfo" : {
        "type" : "string",
        "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
        "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP."
    },
    "description" : {
        "type" : [ "string", "null" ],
        "maxLength" : 64,
        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Description of the AP"
    },
    "administrativeState" : {
        "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
        "enum" : [ "Locked", "Unlocked" ]
    },
    "provisionChecklist" : {
        "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
        "type" : "string"
    },
    "wlanService24Enabled" : {
        "description" : "WLAN service enabled or disabled on 2.4GHz radio",
        "type" : "boolean"
    },
    "wlanService50Enabled" : {
        "description" : "WLAN service enabled or disabled on 5GHz radio",
        "type" : "boolean"
    },
    "channelEvaluationInterval" : {
        "description" : "channel evaluation Interval of the AP",
        "type" : "integer",
        "default" : 600,
        "minimum" : 60,
        "maximum" : 3600
    }
}

Response 204

Diable Location Override

DELETE

/v2_1/aps/{apMac}/location

Use this API command to disable AP level override of location. The access point will take its group’s configuration or zone’s configuration.

Response 204

Diable Location AdditionalInfo Override

DELETE

/v2_1/aps/{apMac}/locationAdditionalInfo

Use this API command to disable AP level override of location additionalInfo. The access point will take its group’s configuration or zone’s configuration.

Response 204

PATCH

/v2_1/aps/{apMac}/login

Use this API command to enable or modify the AP-level logon override settings.

RequestShowHide

Body

{
    "apLoginName" : "apLoginName",
    "apLoginPassword" : "apLoginPassword"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "apLoginName" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
            "description" : "User name of the AP administrator"
        },
        "apLoginPassword" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
            "description" : "Password of the AP administrator"
        }
    },
    "required" : [ "apLoginName", "apLoginPassword" ],
    "description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level."
}

Response 204

Modify Syslog Override

PATCH

/v2_1/aps/{apMac}/syslog

Use this API command to enable or modify the AP-level syslog override settings.

RequestShowHide

Body

{
    "enabled" : true,
    "address" : "1.1.1.1",
    "port" : 514,
    "facility" : "keep_Original",
    "priority" : "Error"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "enabled" : {
            "description" : "Indicates whether syslog is enabled or disabled",
            "type" : "boolean"
        },
        "address" : {
            "type" : "string",
            "description" : "Address of the syslog server. If syslog is enabled, this attribute is required."
        },
        "port" : {
            "description" : "Port number of the syslog server",
            "type" : "integer",
            "default" : "514",
            "minimum" : 1,
            "maximum" : 65535
        },
        "facility" : {
            "description" : "Facility of the syslog server",
            "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
        },
        "priority" : {
            "description" : "Priority of the log messages",
            "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
        }
    },
    "required" : [ "enabled" ],
    "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level."
}

Response 204

Diable Syslog Override

DELETE

/v2_1/aps/{apMac}/syslog

Use this API command to disable the AP level syslog override. The access point will take its group’s or zone’s configuration.

Response 204

Modify Radio 2.4G Override

PATCH

/v2_1/aps/{apMac}/wifi24

Use this API command to modify the AP level override of the 2.4GHz radio configuration.

RequestShowHide

Body

{
    "txPower" : "txPower",
    "channelWidth" : 1,
    "channel" : 13
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "txPower" : {
            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
            "description" : "Transmission power"
        },
        "channelWidth" : {
            "description" : "Channel width (only 20 is currently supported)",
            "enum" : [ 20 ]
        },
        "channel" : {
            "description" : "Channel number",
            "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
        }
    },
    "description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level."
}

Response 204

Disable Radio 2.4G Override

DELETE

/v2_1/aps/{apMac}/wifi24

Use this API command to disable the AP level override of the 2.4GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.

Response 204

Modify Radio 5G Override

PATCH

/v2_1/aps/{apMac}/wifi50

Use this API command to Modify the AP level override of the 5GHz radio configuration.

RequestShowHide

Body

{
    "txPower" : "txPower",
    "channelWidth" : 1,
    " channel" : 1
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "txPower" : {
            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
            "description" : "transmission power"
        },
        "channelWidth" : {
            "description" : "channel width, 0 mean Auto",
            "enum" : [ 0, 20, 40, 80 ]
        },
        "channel" : {
            "description" : "channel number",
            "enum" : [ 0, 36, 40, 44, 48, 149, 153, 157, 161 ]
        }
    },
    "description" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level."
}

Response 204

Disable Radio 5G Override

DELETE

/v2_1/aps/{apMac}/wifi50

Use this API command to disable the AP level override of 5GHz radio configuration. The access point will take its group’s or zone’s configuration.

Response 204

Modify WLAN Group 2.4G Override

PATCH

/v2_1/aps/{apMac}/wlanGroup24

Use this API command to enable or modify the AP level override of the WLAN group configuration on the 2.4GHz radio.

RequestShowHide

Body

{
    "id" : "wlanGroupUUID",
    "name" : "wlanGroupName"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the WLAN group",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the WLAN group",
            "type" : "string"
        }
    },
    "description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level."
}

Response 204

Disable WLAN Group 2.4G Override

DELETE

/v2_1/aps/{apMac}/wlanGroup24

Use this API command to disable the AP level override of WLAN group configuration on 2.4GHz radio. The access point will take its group’s or zone’s configuration.

Response 204

Modify WLAN Group 5G Override

PATCH

/v2_1/aps/{apMac}/wlanGroup50

Use this API command to enable or modify the AP level override of the WLAN group configuration on the 5GHz radio.

RequestShowHide

Body

{
    "id" : "wlanGroupUUID",
    "name" : "wlanGroupName"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the WLAN group",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the WLAN group",
            "type" : "string"
        }
    },
    "description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level."
}

Response 204

Disable WLAN group 5G Override

DELETE

/v2_1/aps/{apMac}/wlanGroup50

Use this API command to disable the AP level override of WLAN group on the 5GHz radio. The access point will take its group’s or zone’s configuration.

Response 204

Modify Network Settings

PATCH

/v2_1/aps/{apMac}/network

Use this API command to modify the network settings of an AP.

RequestShowHide

Body

{
    "ipType" : "Static",
    "ip" : "1.1.1.1",
    "netmask" : "255.255.255.0",
    "gateway" : "1.1.1.0",
    "primaryDns" : "8.8.8.8",
    "secondaryDns" : "8.8.8.9"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "ipType" : {
            "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
            "enum" : [ "Static", "Dynamic", "Keep" ]
        },
        "ip" : {
            "type" : "string",
            "description" : "IP address of the AP"
        },
        "netmask" : {
            "type" : "string",
            "pattern" : "(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
            "description" : "Netmask of the AP's subnet"
        },
        "gateway" : {
            "type" : "string",
            "description" : "Gateway of the AP"
        },
        "primaryDns" : {
            "type" : "string",
            "description" : "Primary DNS server address of the AP"
        },
        "secondaryDns" : {
            "type" : "string",
            "description" : "Secondary DNS server address of the AP"
        }
    },
    "description" : "Network settings of the AP."
}

Response 204

Modify Smart Monitor

PATCH

/v2_1/aps/{apMac}/smartMonitor

Use this API command to modify smart monitor of an AP.

RequestShowHide

Body

{
    "enabled" : true,
    "intervalInSec" : 10,
    "retryThreshold" : 10
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "enabled" : {
            "type" : "boolean"
        },
        "intervalInSec" : {
            "description" : "Interval in seconds. This is required if smartMonitor is enabled",
            "type" : "integer",
            "default" : 10,
            "minimum" : 5,
            "maximum" : 60
        },
        "retryThreshold" : {
            "description" : "Retry threshold. This is required if smartMonitor is enabled",
            "type" : "integer",
            "default" : 3,
            "minimum" : 1,
            "maximum" : 10
        }
    },
    "description" : "Smart monitor of the AP."
}

Response 204

Disable Smart Monitor Override

DELETE

/v2_1/aps/{apMac}/smartMonitor

Use this API command to disable AP level override of smart monitor. The access point will take its group’s configuration or zone’s configuration.

Response 204

Modify Bonjour Gateway

PATCH

/v2_1/aps/{apMac}/bonjourGateway

Use this API command to modify bonjour gateway of an AP.

RequestShowHide

Body

{
    "id" : "bonjourGatewayUUID",
    "name" : "bonjourGatewayName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Bonjour gateway of the AP."
}

Response 204

Disable Bonjour Gateway Override

DELETE

/v2_1/aps/{apMac}/bonjourGateway

Use this API command to disable AP level override of bonjour gateway. The access point will take its group’s configuration or zone’s configuration.

Response 204

Modify Client Admission Control 2.4G

PATCH

/v2_1/aps/{apMac}/clientAdmissionControl24

Use this API command to modify client admission control 2.4GHz radio configuration of an AP.

RequestShowHide

Body

{
    "maxRadioLoadPercent" : 70,
    "minClientCount" : 30,
    "minClientThroughputMbps" : 10.0,
    "enabled" : true
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "enabled" : {
            "type" : "boolean"
        },
        "maxRadioLoadPercent" : {
            "description" : "Maximum radio load percentage.",
            "type" : "integer",
            "default" : 75,
            "minimum" : 50,
            "maximum" : 100
        },
        "minClientCount" : {
            "description" : "Minimum client count number.",
            "type" : "integer",
            "default" : 10,
            "minimum" : 0,
            "maximum" : 100
        },
        "minClientThroughputMbps" : {
            "description" : "Minimum client throughput in Mbps.",
            "type" : "number",
            "default" : 0,
            "minimum" : 0,
            "maximum" : 100
        }
    },
    "description" : "Client admission control configuration of 2.4GHz radio of the AP."
}

Response 204

Disable Client Admission Control 2.4G Override

DELETE

/v2_1/aps/{apMac}/clientAdmissionControl24

Use this API command to disable AP level override of client admission control 2.4GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.

Response 204

Modify Client Admission Control 5G

PATCH

/v2_1/aps/{apMac}/clientAdmissionControl50

Use this API command to modify client admission control 5GHz radio configuration of an AP.

RequestShowHide

Body

{
    "maxRadioLoadPercent" : 70,
    "minClientCount" : 30,
    "minClientThroughputMbps" : 10.0,
    "enabled" : true
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "enabled" : {
            "type" : "boolean"
        },
        "maxRadioLoadPercent" : {
            "description" : "Maximum radio load percentage.",
            "type" : "integer",
            "default" : 75,
            "minimum" : 50,
            "maximum" : 100
        },
        "minClientCount" : {
            "description" : "Minimum client count number.",
            "type" : "integer",
            "default" : 10,
            "minimum" : 0,
            "maximum" : 100
        },
        "minClientThroughputMbps" : {
            "description" : "Minimum client throughput in Mbps.",
            "type" : "number",
            "default" : 0,
            "minimum" : 0,
            "maximum" : 100
        }
    },
    "description" : "Client admission control configuration of 5GHz radio of the AP."
}

Response 204

Disable Client Admission Control 5G Override

DELETE

/v2_1/aps/{apMac}/clientAdmissionControl50

Use this API command to disable AP level override of client admission control 5GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.

Response 204

Modify Venue Profile

PATCH

/v2_1/aps/{apMac}/venueProfile

Use this API command to modify venue profile of an AP.

RequestShowHide

Body

{
    "id" : "venueProfileId",
    "name" : "venueProfileName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Venue profile configuration of the AP."
}

Response 204

Disable Venue Profile Override

DELETE

/v2_1/aps/{apMac}/venueProfile

Use this API command to disable AP level override of venue profile. The access point will take its group’s configuration or zone’s configuration.

Response 204

Modify Model Specific

PUT

/v2_1/aps/{apMac}/specific

Use this API command to modify model specific configuration.

RequestShowHide

Body

{
    "ledStatusEnabled" : false,
    "lldp" : {
        "enabled" : true,
        "advertiseIntervalInSec" : 100,
        "holdTimeInSec" : 1000,
        "managementIPTLVEnabled" : false
    },
    "ledMode" : null,
    "internalHeaterEnabled" : null,
    "poeOutPortEnabled" : null,
    "poeModeSetting" : null,
    "usbPowerEnable" : null,
    "radioBand" : null,
    "externalAntenna24" : null,
    "externalAntenna50" : null,
    "lanPorts" : [ {
        "portName" : "LAN1",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 13,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Disable",
            "authenticator" : null,
            "supplicant" : null
        }
    }, {
        "portName" : "LAN2",
        "enabled" : true,
        "type" : "Access",
        "vlanUntagId" : 15,
        "members" : "15",
        "_8021X" : {
            "type" : "MACBasedAuthenticator",
            "authenticator" : {
                "authentication" : {
                    "id" : "5f66275c-b1fd-4e25-a4db-b64115740fb9",
                    "name" : "zoneRadius"
                },
                "accounting" : {
                    "id" : "b86db5e8-884b-4c90-9315-dcd72acaf743",
                    "name" : "zoneRadiusAcct"
                },
                "macAuthByPassEnabled" : true
            },
            "supplicant" : null
        }
    }, {
        "portName" : "LAN3",
        "enabled" : true,
        "type" : "Trunk",
        "vlanUntagId" : 1,
        "members" : "1-4094",
        "_8021X" : {
            "type" : "Supplicant",
            "authenticator" : null,
            "supplicant" : {
                "type" : "Custom",
                "userName" : "a",
                "password" : "a"
            }
        }
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "ledStatusEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "lldp" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "advertiseIntervalInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 1,
                    "maximum" : 300
                },
                "holdTimeInSec" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 60,
                    "maximum" : 1200
                },
                "managementIPTLVEnabled" : {
                    "type" : [ "boolean", "null" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "ledMode" : {
            "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
        },
        "internalHeaterEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeOutPortEnabled" : {
            "type" : [ "boolean", "null" ]
        },
        "poeModeSetting" : {
            "enum" : [ null, "Auto", "_802_3af" ]
        },
        "usbPowerEnable" : {
            "type" : [ "boolean", "null" ]
        },
        "radioBand" : {
            "enum" : [ null, "2.4GHz", "5GHz" ]
        },
        "externalAntenna24" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "externalAntenna50" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "dbi" : {
                    "type" : [ "integer", "null" ],
                    "minimum" : 0,
                    "maximum" : 90
                },
                "chainMask" : {
                    "enum" : [ null, "Two", "Three" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "lanPorts" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "portName" : {
                        "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                    },
                    "enabled" : {
                        "type" : "boolean"
                    },
                    "type" : {
                        "enum" : [ null, "Access", "Trunk", "General" ]
                    },
                    "vlanUntagId" : {
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 4094
                    },
                    "members" : {
                        "type" : [ "string", "null" ]
                    },
                    "_8021X" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "type" : {
                                "enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
                            },
                            "authenticator" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "authentication" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "accounting" : {
                                        "type" : [ "object", "null" ],
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "id" : {
                                                "type" : "string"
                                            },
                                            "name" : {
                                                "type" : "string"
                                            }
                                        }
                                    },
                                    "macAuthByPassEnabled" : {
                                        "type" : "boolean"
                                    }
                                },
                                "required" : [ "authentication", "macAuthByPassEnabled" ]
                            },
                            "supplicant" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "type" : {
                                        "enum" : [ "MACAddress", "Custom" ]
                                    },
                                    "userName" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                                    },
                                    "password" : {
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64,
                                        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                                    }
                                },
                                "required" : [ "type" ]
                            }
                        },
                        "required" : [ "type" ]
                    }
                },
                "required" : [ "portName", "enabled" ]
            }
        }
    }
}

Response 204

Disable Model Specific Override

DELETE

/v2_1/aps/{apMac}/specific

Use this API command to disable model specific configuration override from AP group or zone.

Response 204

Upload AP Picture

POST

/v2_1/aps/{apMac}/picture

Use this API command to upload a new AP picture.

RequestShowHide
Body
```
Binary data for the picture
```
Response 204

Modify AP Picture

PUT

/v2_1/aps/{apMac}/picture

Use this API command to modify an AP picture

RequestShowHide
Body
```
Binary data for the picture
```
Response 204

Delete AP Picture

DELETE

/v2_1/aps/{apMac}/picture

Use this API command to delete an AP picture.

Response 204

Disable AP Channel Evaluation Interval

DELETE

/v2_1/aps/{apMac}/channelEvaluationInterval

Disable AP lChannel Evaluation Interval. The access point will take its group’s configuration or zone’s configuration.

Response 204

Delete

DELETE

/v2_1/aps/{apMac}

Use this API command to delete an access point.

Response 204

Reboot

PUT

/v2_1/aps/{apMac}/reboot

reboot an access point

Response 204

Access Point Operational

Retrieve Operational Information

GET

/v2_1/aps/{apMac}/operational/summary

Use this API command to retrieve the operational information of an AP.

Response 200ShowHide

Body

{
    "mac" : "00:11:22:33:44:55",
    "zoneId" : "zoneUUID",
    "apGroupId" : "apGroupUUID",
    "serial" : "00000096",
    "model" : "ZF7962",
    "name" : "apName",
    "version" : "3.0.0.385",
    "description" : "apDescription",
    "countryCode" : "US",
    "latitude" : 22.3,
    "longitude" : 114,
    "location" : "location",
    "cpId" : "controlPlaneUUID",
    "dpId" : "dataPlaneUUID",
    "wifi24Channel" : "2",
    "wifi50Channel" : "6",
    "meshRole" : "Map",
    "meshHop" : 2,
    "ipType" : "Static",
    "ip" : "1.1.1.1",
    "ipv6Type" : null,
    "ipv6" : null,
    "externalIp" : "172.18.11.11",
    "externalPort" : 675,
    "configState" : "newConfig",
    "connectionState" : "Connected",
    "registrationState" : "Approved",
    "administrativeState" : "Unlocked",
    "provisionMethod" : "Discovered",
    "provisionStage" : "Waiting for Registration",
    "isCriticalAP" : true,
    "approvedTime" : 111111,
    "lastSeenTime" : 111111,
    "uptime" : 111111,
    "clientCount" : 2
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
            "description" : "MAC address of the AP"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
            "description" : "Name of the AP"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the AP"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "Firmware version of the AP"
        },
        "countryCode" : {
            "description" : "Country code of the AP",
            "type" : "string"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) of the AP"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) of the AP"
        },
        "location" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Location of the AP. This is a text description that indicates the location of the AP."
        },
        "cpId" : {
            "description" : "Identifier of the control plane to which the AP is currently connected",
            "type" : "string"
        },
        "dpId" : {
            "description" : "Identifier of the data plane to which the AP is currently connected",
            "type" : "string"
        },
        "wifi24Channel" : {
            "description" : "2.4GHz radio channel number that the AP is currently using",
            "type" : "string"
        },
        "wifi50Channel" : {
            "description" : "5GHZ radio channel number that the AP is currently using",
            "type" : "string"
        },
        "meshRole" : {
            "description" : "Mesh role of the AP",
            "enum" : [ "Disabled", "Root", "Map", "eMap", "Down", "Undefined" ]
        },
        "meshHop" : {
            "description" : "Number of mesh hops of the AP. This is only applicable to mesh APs.",
            "type" : "integer"
        },
        "ipType" : {
            "description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or dynamically assigned or kept unchanged.",
            "enum" : [ "Static", "Dynamic", "Keep" ]
        },
        "ip" : {
            "description" : "IP address of the AP",
            "type" : "string"
        },
        "externalIp" : {
            "description" : "External IP address of the AP. This is only applicable when the AP is behind a NAT server.",
            "type" : "string"
        },
        "externalPort" : {
            "description" : "External port number of the AP. This is only applicable when the AP is behind a NAT server.",
            "type" : "integer"
        },
        "configState" : {
            "description" : "State of the AP configuration.",
            "enum" : [ "newConfig", "fwApplied", "fwDownloaded", "fwFailed", "configApplied", "completed", "configFailed" ]
        },
        "connectionState" : {
            "description" : "Connection state of the AP",
            "type" : "string"
        },
        "registrationState" : {
            "description" : "Registration state of the AP",
            "type" : "string"
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "provisionMethod" : {
            "description" : "Provisioning method of the AP. Discovered indicates that the AP contacted the controller using discovery and the AP did not have pre-existing record on the controller. Preprovision indicates that the AP was provisioned to the controller before AP made the first contact. Swap indicates that the AP was provisioned to be a replacement of an existing AP.",
            "enum" : [ "Discovered", "Preprovision", "Swap" ]
        },
        "provisionStage" : {
            "description" : "Provisioning stage of the AP. This indicates the stage at which the AP is at in the provisioning process.",
            "type" : "string"
        },
        "isCriticalAP" : {
            "description" : "Indicates critical APs. Critical AP are APs that were tagged by the controller based on predefined rules.",
            "type" : "boolean"
        },
        "approvedTime" : {
            "description" : "Timestamp when the AP was approved by the controller",
            "type" : "integer"
        },
        "lastSeenTime" : {
            "description" : "Timestamp of the last successful communication with the AP",
            "type" : "integer"
        },
        "uptime" : {
            "description" : "Uptime of the AP since it was last rebooted",
            "type" : "integer"
        },
        "clientCount" : {
            "description" : "Number of clients on the AP",
            "type" : "integer"
        }
    }
}

Retrieve Alarm Summary

GET

/v2_1/aps/{apMac}/operational/alarmSummary

Use this API command to retrieve the alarm summary of an AP.

Response 200ShowHide

Body

{
    "criticalCount" : 3,
    "majorCount" : 3,
    "minorCount" : 4,
    "warningCount" : 0
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "criticalCount" : {
            "description" : "Critical alarm count",
            "type" : "integer"
        },
        "majorCount" : {
            "description" : "Major alarm count",
            "type" : "integer"
        },
        "minorCount" : {
            "description" : "Minor alarm count",
            "type" : "integer"
        },
        "warningCount" : {
            "description" : "Warning alarm count",
            "type" : "integer"
        }
    }
}

Retrieve Event Summary

GET

/v2_1/aps/{apMac}/operational/eventSummary

Use this API command to retrieve the event summary of an AP.

Response 200ShowHide

Body

{
    "criticalCount" : 4,
    "majorCount" : 2,
    "minorCount" : 5,
    "warningCount" : 5,
    "informationalCount" : 2,
    "debugCount" : 5
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "criticalCount" : {
            "description" : "Critical event count",
            "type" : "integer"
        },
        "majorCount" : {
            "description" : "Major event count",
            "type" : "integer"
        },
        "minorCount" : {
            "description" : "Minor event count",
            "type" : "integer"
        },
        "warningCount" : {
            "description" : "Warning event count",
            "type" : "integer"
        },
        "informationalCount" : {
            "description" : "Informational event count",
            "type" : "integer"
        },
        "debugCount" : {
            "description" : "Debug event count",
            "type" : "integer"
        }
    }
}

Retrieve Alarm List

GET

/v2_1/aps/{apMac}/operational/alarms

Use this API command to retrieve the list of outstanding alarms on an AP.

Parameters
index
number (optional)
The index of the first entry to be retrieved. Default: 0

listSize
number (optional)
The maximum number of entries to be retrieved. Default: 100

severity
string (optional)
filter by severity

category
string (optional)
filter by category

code
number (optional)
filter by alarm code

startTime
string (optional)
filter by trigger time later than startTime (milliseconds in UTC time)

endTime
string (optional)
filter by trigger time earlier than endTime (milliseconds in UTC time)

status
string (optional)
filter by alarm status

Response 200ShowHide

Body

{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "id" : "538324f5-f085-4567-ae3f-6b40244d38d6",
        "time" : 1408715298000,
        "code" : 302,
        "category" : "AP Communication",
        "type" : "AP rebooted by system",
        "severity" : "Major",
        "description" : "AP [[email protected]:C9:A1:1D:55:A0] rebooted because of [application, wsgclient, reboot due to switch radio band].",
        "status" : "Outstanding",
        "clearedTime" : null,
        "acknowledgedTime" : null
    }, {
        "id" : "5cc35da9-4d3c-4c9a-97e0-303d9b2b1776",
        "time" : 1408715248732,
        "code" : 307,
        "category" : "AP Communication",
        "type" : "AP heartbeat lost",
        "severity" : "Informational",
        "description" : "AP [[email protected]:C9:A1:1D:55:A0] heartbeat lost.",
        "status" : "Cleared",
        "clearedTime" : 1408715299243,
        "acknowledgedTime" : null
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "description" : "Total alarm count",
            "type" : "integer"
        },
        "hasMore" : {
            "description" : "Indicates whether there are more alarms after the currently displayed list",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first alarm returned from the complete alarm list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                        "description" : "Identifier of the alarm"
                    },
                    "time" : {
                        "description" : "Time of the alarm",
                        "type" : "string"
                    },
                    "code" : {
                        "description" : "Alarm code",
                        "type" : "string"
                    },
                    "category" : {
                        "description" : "Alarm category",
                        "type" : "string"
                    },
                    "type" : {
                        "description" : "Alarm type",
                        "type" : "string"
                    },
                    "severity" : {
                        "description" : "Alarm severity",
                        "enum" : [ "Critical", "Major", "Minor", "Warning", "Informational" ]
                    },
                    "description" : {
                        "description" : "Alarm description",
                        "type" : "string"
                    },
                    "status" : {
                        "description" : "Alarm status",
                        "enum" : [ "Outstanding", "Acknowledged", "Cleared" ]
                    },
                    "clearedTime" : {
                        "description" : "Time that alarm was cleared",
                        "type" : "integer"
                    },
                    "acknowledgedTime" : {
                        "description" : "Time the alarm was acknowledged",
                        "type" : "integer"
                    }
                }
            }
        }
    }
}

Retrieve Event List

GET

/v2_1/aps/{apMac}/operational/events

Use this API command to retrieve the list of events from an AP.

Parameters
index
number (optional)
The index of the first entry to be retrieved. Default: 0

listSize
number (optional)
The maximum number of entries to be retrieved. Default: 100

severity
string (optional)
filter by severity

category
string (optional)
filter by category

code
number (optional)
filter by event code

startTime
string (optional)
filter by trigger time later than startTime (milliseconds in UTC time)

endTime
string (optional)
filter by trigger time earlier than endTime (milliseconds in UTC time)

Response 200ShowHide

Body

{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "id" : "7a06627a-f739-4aac-b2a1-5fc6d7bb2767",
        "time" : 1408648612000,
        "code" : 110,
        "category" : "AP Communication",
        "type" : "AP configuration updated",
        "severity" : "Informational",
        "description" : "AP [[email protected]:C9:A1:1D:55:A0] updated to configuration [af8d97a0-2967-11e4-91cf-000c29b1347d]."
    }, {
        "id" : "8c5796c1-746c-460b-81f0-f97b8ab2b74f",
        "time" : 1408648603000,
        "code" : 109,
        "category" : "AP Communication",
        "type" : "Updating AP configuration...",
        "severity" : "Informational",
        "description" : "AP [[email protected]:C9:A1:1D:55:A0] is being updated to new configuration ID [af8d97a0-2967-11e4-91cf-000c29b1347d]."
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "description" : "Total event count",
            "type" : "integer"
        },
        "hasMore" : {
            "description" : "Indicates whether there are more events after the currently displayed list",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first event returned from the complete event list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                        "description" : "Identifier of the event"
                    },
                    "time" : {
                        "description" : "Time of the event",
                        "type" : "string"
                    },
                    "code" : {
                        "description" : "Event code",
                        "type" : "string"
                    },
                    "category" : {
                        "description" : "Event category",
                        "type" : "string"
                    },
                    "type" : {
                        "description" : "Event type",
                        "type" : "string"
                    },
                    "severity" : {
                        "description" : "Event severity",
                        "enum" : [ "Critical", "Major", "Minor", "Warning", "Informational", "Debug" ]
                    },
                    "description" : {
                        "description" : "Event description",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve Mesh Neighbor AP List

GET

/v2_1/aps/{apMac}/operational/neighbor

Use this API command to retrieve a list of neighbor access points on mesh AP.

Parameters
index
number (optional)
The index of the first entry to be retrieved. Default: 0

listSize
number (optional)
The maximum number of entries to be retrieved. Default: 100

Response 200ShowHide

Body

{
    "totalCount" : 1,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "mac" : "8C:0C:90:2B:8B:90",
        "model" : "ZF7372",
        "name" : "RuckusAP",
        "version" : "3.1.0.0.157",
        "ip" : "10.2.6.239",
        "externalIp" : "10.2.6.239",
        "externalPort" : "58788",
        "connectionState" : "Connect",
        "channel" : "40 (11a/n)",
        "signal" : "119%",
        "zoneName" : "neilMeshZone"
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "description" : "Total mesh neighbor APs count",
            "type" : "integer"
        },
        "hasMore" : {
            "description" : "Indicator of whether there are more Mesh Neighbor APs after the current displayed list",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first Mesh Neighbor AP returned out of the complete Mesh Neighbor AP list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "mac" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
                        "description" : "MAC address of the mesh neighbor AP"
                    },
                    "name" : {
                        "description" : "Name of the mesh neighbor AP",
                        "type" : "string"
                    },
                    "zoneName" : {
                        "description" : "Name of the zone which the mesh neighbor AP belongs to",
                        "type" : "string"
                    },
                    "ip" : {
                        "description" : "IP address of the mesh neighbor AP",
                        "type" : "string"
                    },
                    "externalIp" : {
                        "description" : "External IP of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "externalPort" : {
                        "description" : "External port of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "model" : {
                        "description" : "Model of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "version" : {
                        "description" : "Firmware version of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "channel" : {
                        "description" : "Channel of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "signal" : {
                        "description" : "Signal of the mesh neighbor AP ",
                        "type" : "string"
                    },
                    "connectionState" : {
                        "description" : "Connection state of the mesh neighbor AP ",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

WLAN Group

Retrieve List

GET

/v2_1/rkszones/{zoneId}/wlangroups

Use this API command to retrieve the list of WLAN groups within a zone.

Parameters
index
number (optional)
The index of the first entry to be retrieved. Default: 0

listSize
number (optional)
The maximum number of entries to be retrieved. Default: 100

Response 200ShowHide

Body

{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "id" : "wlanGroupUUID",
        "name" : "wlanGroupName",
        "description" : "wlanGroupDescription",
        "members" : [ {
            "id" : "wlanUUID",
            "accessVlan" : 1,
            "nasId" : "nasId",
            "vlanPooling" : null
        } ]
    }, {
        "id" : "wlanGroupUUID2",
        "zoneId" : "zoneUUID",
        "name" : "wlanGroupName2",
        "description" : "wlanGroupDescription2",
        "members" : [ {
            "id" : "wlanUUID2",
            "accessVlan" : 1,
            "nasId" : "nasId",
            "vlanPooling" : null
        } ]
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the WLAN group",
                        "type" : "string"
                    },
                    "zoneId" : {
                        "description" : "Identifier of the zone to which the WLAN group belongs",
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
                        "description" : "Name of the WLAN group"
                    },
                    "description" : {
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                        "description" : "Description of the WLAN group"
                    },
                    "members" : {
                        "description" : "Members of the WLAN group",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "description" : "Identifier of the WLAN",
                                    "type" : "string"
                                },
                                "accessVlan" : {
                                    "description" : "Access VLAN",
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 4094
                                },
                                "vlanPooling" : {
                                    "type" : [ "object", "null" ],
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "id" : {
                                            "type" : "string"
                                        },
                                        "name" : {
                                            "type" : "string"
                                        }
                                    },
                                    "description" : "Vlan pooling"
                                },
                                "nasId" : {
                                    "description" : "NAS-ID",
                                    "type" : "string",
                                    "maxLength" : 63,
                                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
                                }
                            },
                            "required" : [ "id" ]
                        }
                    }
                },
                "required" : [ "name" ]
            }
        }
    }
}

Retrieve

GET

/v2_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to retrieve the WLAN group.

Response 200ShowHide

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the WLAN group",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the WLAN group belongs",
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the WLAN group"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN group"
        },
        "members" : {
            "description" : "Members of the WLAN group",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the WLAN",
                        "type" : "string"
                    },
                    "accessVlan" : {
                        "description" : "Access VLAN",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 4094
                    },
                    "vlanPooling" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        },
                        "description" : "Vlan pooling"
                    },
                    "nasId" : {
                        "description" : "NAS-ID",
                        "type" : "string",
                        "maxLength" : 63,
                        "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
                    }
                },
                "required" : [ "id" ]
            }
        }
    },
    "required" : [ "name" ]
}

Create

POST

/v2_1/rkszones/{zoneId}/wlangroups

Use this API command to create a new WLAN group.

RequestShowHide

Body

{
    "name" : "wlanGroupName",
    "description" : "wlanGroupDescription"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the WLAN group"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN group"
        }
    },
    "required" : [ "name" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanGroupUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the WLAN group",
            "type" : "string"
        }
    }
}

Modify Basic

PATCH

/v2_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to modify the basic information of a WLAN group.

RequestShowHide

Body

{
    "name" : "wlanGroupNameModified",
    "description" : "wlanGroupDescriptionModified"
}

Schema

{
    "name" : {
        "type" : "string",
        "minLength" : 2,
        "maxLength" : 32,
        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
        "description" : "Name of the WLAN group"
    },
    "description" : {
        "type" : [ "string", "null" ],
        "maxLength" : 64,
        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Description of the WLAN group"
    }
}

Response 204

Add Member

POST

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members

Use this API command to add a member to a WLAN group.

RequestShowHide

Body

{
    "id" : "wlanUUID",
    "accessVlan" : 1
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the WLAN",
            "type" : "string"
        },
        "accessVlan" : {
            "description" : "Access VLAN",
            "type" : "integer",
            "minimum" : 1,
            "maximum" : 4094
        },
        "vlanPooling" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Vlan pooling"
        },
        "nasId" : {
            "description" : "NAS-ID",
            "type" : "string",
            "maxLength" : 63,
            "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
        }
    },
    "required" : [ "id" ]
}

Response 201

Modify Member

PATCH

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}

Use this API command to modify a member of a WLAN group.

RequestShowHide

Body

{
    "accessVlan" : 23,
    "nasId" : "nasId"
}

Schema

{
    "accessVlan" : {
        "description" : "Access VLAN",
        "type" : "integer",
        "minimum" : 1,
        "maximum" : 4094
    },
    "nasId" : {
        "description" : "NAS-ID",
        "type" : "string",
        "maxLength" : 63,
        "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
    }
}

Response 204

Modify Member VLAN Pooling

PATCH

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanPooling

Use this API command to modify a member’s VLAN pooling of a WLAN group.

RequestShowHide

Body

{
    "id" : "a61997e0-699b-11e4-b9bb-08002716c79f",
    "name" : "zoneVlanPooling"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Vlan pooling"
}

Response 204

Disable Member VLAN Override

DELETE

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanOverride

Use this API command to disable a member VLAN override of a WLAN group.

Response 204

Disable Member NAS Override

DELETE

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/nasId

Use this API command to disable a member NAS-ID override of a WLAN group.

Response 204

Remove Member

DELETE

/v2_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}

Use this API command to remove a member from a WLAN group.

Response 204

Delete

DELETE

/v2_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to delete a WLAN group.

Response 204

WLAN

Retrieve List

GET

/v2_1/rkszones/{zoneId}/wlans

Use this API command to retrieve a list of WLANs within a zone.

Parameters
index
number (optional)
The index of the first entry to be retrieved. Default: 0

listSize
number (optional)
The maximum number of entries to be retrieved. Default: 100

Response 200ShowHide

Body

{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "id" : "1028",
        "name" : "wlan2",
        "ssid" : "wlan2"
    }, {
        "id" : "1027",
        "zoneId" : "21a18b1c-e260-48c8-866c-69e66c81368e",
        "name" : "wlan1",
        "ssid" : "wlan1"
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the WLAN",
                        "type" : "string"
                    },
                    "mvnoId" : {
                        "description" : "Tenant UUID",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the WLAN",
                        "type" : "string"
                    },
                    "ssid" : {
                        "description" : "SSID of the WLAN",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve

GET

/v2_1/rkszones/{zoneId}/wlans/{id}

Use this API command to retrieve a WLAN.

Response 200ShowHide

Body

{
    "id" : "1027",
    "zoneId" : "21a18b1c-e260-48c8-866c-69e66c81368e",
    "name" : "wlan1",
    "ssid" : "wlan1",
    "description" : "",
    "type" : "Standard_Open",
    "encryption" : {
        "method" : "None"
    },
    "macAuth" : null,
    "authServiceOrProfile" : null,
    "accountingServiceOrProfile" : {
        "id" : "",
        "name" : null,
        "throughController" : false,
        "interimUpdateMin" : null,
        "accountingDelayEnabled" : null
    },
    "accessTunnelType" : "APLBO",
    "portalServiceProfile" : null,
    "hotspot20Profile" : null,
    "defaultUserTrafficProfile" : {
        "id" : "24f24c00-0b47-11e4-a9b5-000c29b1347d",
        "name" : "Factory Default"
    },
    "l2ACL" : null,
    "devicePolicy" : null,
    "vlan" : {
        "accessVlan" : 1,
        "dynamicVlanEnabled" : false
    },
    "schedule" : {
        "id" : null,
        "name" : null,
        "type" : "AlwaysOn"
    },
    "radiusOptions" : {
        "nasIdType" : "WLAN_BSSID",
        "customizedNasId" : null,
        "nasRequestTimeoutSec" : 3,
        "nasMaxRetry" : 2,
        "nasReconnectPrimaryMin" : 5,
        "calledStaIdType" : "WLAN_BSSID"
    },
    "advancedOptions" : {
        "uplinkRateLimiting" : "Disable",
        "downlinkRateLimiting" : "Disable",
        "clientIsolcationEnabled" : false,
        "priority" : "High",
        "zeroItActivationEnabled" : false,
        "hideSsidEnabled" : true,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : false,
        "dgafEnabled" : null,
        "maxClientsPerRadio" : 100,
        "support80211dEnabled" : false,
        "forceDHCPEnabled" : false,
        "forceClientDHCPTimeout" : 10,
        "dhcpOption82Enabled" : false,
        "dhcp82Format" : "RUCKUS_DEFAULT",
        "unauthClientStatsEnabled" : false,
        "clientIdleTimeoutSec" : 120,
        "clientFingerprintingEnabled" : false,
        "ofdmOnlyEnabled" : false,
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "bandBalancing" : "UseZoneSetting"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ]
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the WLAN",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the WLAN belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : "string"
        },
        "type" : {
            "description" : "Type of the WLAN",
            "enum" : [ "Standard_Open", "Standard_80211", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20", "Hotspot20_OSEN" ]
        },
        "bypassCNA" : {
            "description" : "By pass Capitive Network Assitance",
            "type" : [ "boolean", "null" ]
        },
        "encryption" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                }
            },
            "required" : [ "method" ],
            "description" : "Encryption of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Autentication of the WLAN"
        },
        "macAuth" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "enum" : [ "Default", "802.1X" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            },
            "description" : "MAC authentication of the WLAN"
        },
        "accountingServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                }
            },
            "description" : "Accounting of the WLAN"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, SoftGRE means AP direct SoftGRE tunnel",
            "enum" : [ "APLBO", "SoftGRE" ]
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
        },
        "defaultUserTrafficProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "User traffic profile of the WLAN"
        },
        "vlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094
                },
                "dynamicVlanEnabled" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "Vlan pooling"
                }
            },
            "description" : "VLAN (access and/or core) of the WLAN."
        },
        "l2ACL" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Layer 2 ACL of the WLAN"
        },
        "devicePolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Device policy of the WLAN"
        },
        "radiusOptions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 63,
                    "pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
                },
                "nasRequestTimeoutSec" : {
                    "description" : "NAS request timeout in seconds",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 2,
                    "maximum" : 20
                },
                "nasMaxRetry" : {
                    "description" : "NAS request maximum retry",
                    "type" : "integer",
                    "default" : 2,
                    "minimum" : 2,
                    "maximum" : 10
                },
                "nasReconnectPrimaryMin" : {
                    "description" : "NAS reconnect primary time in minutes",
                    "type" : "integer",
                    "default" : 5,
                    "minimum" : 1,
                    "maximum" : 60
                },
                "calledStaIdType" : {
                    "description" : "Called station ID type",
                    "enum" : [ "WLAN_BSSID", "AP_MAC" ],
                    "default" : "WLAN_BSSID"
                }
            },
            "description" : "RADIUS options of the WLAN."
        },
        "schedule" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ],
            "description" : "Schedule of the WLAN."
        },
        "advancedOptions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 1000,
                    "default" : 120
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "forceClientDHCPTimeoutSec" : {
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
                    "default" : 0
                },
                "dhcpOption82Enabled" : {
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : true
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ofdmOnlyEnabled" : {
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "bandBalancing" : {
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "description" : "BSS minimum rate (mbps)"
                },
                "mgmtTxRateMbps" : {
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "description" : "Management TX rate (mbps)"
                },
                "zeroItActivationEnabled" : {
                    "description" : "Indicator of whether Zero-IT activation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                }
            },
            "description" : "Advanced settings for the WLAN."
        },
        "diffServProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "DiffServ profile of the WLAN"
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "onlineSignupService" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zeroITOnboarding" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "portal" : {
                            "type" : [ "object", "null" ],
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "type" : "string"
                                },
                                "name" : {
                                    "type" : "string"
                                }
                            },
                            "description" : "Onboarding portal profile"
                        },
                        "authServices" : {
                            "description" : "Authentication services",
                            "type" : "array",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "id" : {
                                        "description" : "Identifier of authentication service",
                                        "type" : "string"
                                    },
                                    "name" : {
                                        "description" : "Authentication service name",
                                        "type" : "string"
                                    },
                                    "credentialType" : {
                                        "description" : "Provisioning credential type",
                                        "enum" : [ "LOCAL", "REMOTE" ]
                                    },
                                    "realm" : {
                                        "type" : "string",
                                        "maxLength" : 255,
                                        "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
                                        "description" : "Device provisioning realm"
                                    },
                                    "expiration" : {
                                        "description" : "Expiration hour. null mean never expire",
                                        "type" : [ "integer", "null" ],
                                        "minimum" : 1,
                                        "maximum" : 175200
                                    }
                                },
                                "required" : [ "credentialType", "realm" ]
                            }
                        }
                    },
                    "required" : [ "portal", "authServices" ],
                    "description" : "Zero-IT Onboarding"
                },
                "onlineSignupEnabled" : {
                    "description" : "Hotspot 2.0 online signup enabled device registration from this guest portal",
                    "type" : "boolean",
                    "default" : false
                }
            },
            "description" : "Online signup service, only support for guest access WLAN"
        }
    }
}

Create - Standard Open

POST

/v2_1/rkszones/{zoneId}/wlans

Use this API command to create a new standard, open and non-tunneled basic WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        }
    },
    "required" : [ "name", "ssid" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Create - 802.1X

POST

/v2_1/rkszones/{zoneId}/wlans/standard80211

Use this API command to create a new standard, 802.1X and non-tunneled WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Create - MAC Auth

POST

/v2_1/rkszones/{zoneId}/wlans/standardmac

Use this API command to create a new standard, MAC auth and non-tunneled WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Create - Hotspot

POST

/v2_1/rkszones/{zoneId}/wlans/wispr

Use this API command to create new hotspot (WISPr) WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required."
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Create - Hotspot + MAC bypass

POST

/v2_1/rkszones/{zoneId}/wlans/wisprmac

Use this API command to create a new hotspot (WISPr) with MAC bypass WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required."
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Create - Guest Access

POST

/v2_1/rkszones/{zoneId}/wlans/guest

Use this API command to create a new guest access WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept."
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Create - Web Auth

POST

/v2_1/rkszones/{zoneId}/wlans/webauth

Use this API command to creates new web authentication WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "authServiceOrProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                }
            },
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required."
        },
        "portalServiceProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Create - Hotspot 2.0

POST

/v2_1/rkszones/{zoneId}/wlans/hotspot20

Use this API command to create a new Hotspot 2.0 access WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "hotspot20Profile" : {
        "id" : "hotspot20ServiceUUID",
        "name" : "hotspot20ServiceName"
    }
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        },
        "hotspot20Profile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Hotspot 2.0 operator profile of the WLAN. The ID or name of the Hotspot 2.0 operator profiles within the zone is required."
        }
    },
    "required" : [ "name", "ssid", "hotspot20Profile" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Create - Hotspot 2.0 OSEN

POST

/v2_1/rkszones/{zoneId}/wlans/hotspot20osen

Use this API command to create a new Hotspot 2.0 Secure Online Signup WLAN.

RequestShowHide

Body

{
    "name" : "api-test-wlanhs20osen",
    "ssid" : "api-test-wlanhs20osen",
    "description" : "wlanDescription"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "Name of the WLAN"
        },
        "ssid" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
            "description" : "SSID of the WLAN"
        },
        "hessid" : {
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "description" : "HESSID of the WLAN"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the WLAN"
        }
    },
    "required" : [ "name", "ssid" ]
}

Response 201ShowHide

Body

{
    "id" : "wlanUUID"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        }
    }
}

Modify Basic

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}

Use this API command to modify the basic information of a WLAN.

RequestShowHide

Body

{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "accessTunnelType" : "SoftGRE"
}

Schema

{
    "name" : {
        "type" : "string",
        "minLength" : 2,
        "maxLength" : 32,
        "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
        "description" : "Name of the WLAN"
    },
    "ssid" : {
        "type" : "string",
        "minLength" : 2,
        "maxLength" : 32,
        "pattern" : "^[ -~]([ -~]){0,30}[ -~]$",
        "description" : "SSID of the WLAN"
    },
    "hessid" : {
        "type" : "string",
        "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
        "description" : "HESSID of the WLAN"
    },
    "description" : {
        "type" : [ "string", "null" ],
        "maxLength" : 64,
        "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
        "description" : "Description of the WLAN"
    },
    "bypassCNA" : {
        "description" : "By pass Capitive Network Assitance",
        "type" : [ "boolean", "null" ]
    },
    "accessTunnelType" : {
        "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
        "enum" : [ "APLBO", "SoftGRE" ]
    }
}

Response 204

Modify Authentication

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/authServiceOrProfile

Use this API command to modify the authentication method of a WLAN.

RequestShowHide

Body

{
    "throughController" : false,
    "id" : "authServiceUUID",
    "name" : "authServiceName"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "throughController" : {
            "description" : "Indicates whether authentication messages were sent through the controller or not",
            "type" : "boolean"
        },
        "id" : {
            "description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
            "type" : "string"
        },
        "locationDeliveryEnabled" : {
            "description" : "RFC5580 location delivery support",
            "type" : "boolean"
        }
    },
    "description" : "Authentication of the WLAN"
}

Response 204

Modify MAC Auth

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/macAuth

Use this API command to modify the MAC authentication settings of a WLAN.

RequestShowHide

Body

{
    "macAuthMacFormat" : "802.1X",
    "customizedPassword" : "password"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "macAuthMacFormat" : {
            "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
            "enum" : [ "Default", "802.1X" ]
        },
        "customizedPassword" : {
            "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
        }
    },
    "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
}

Response 204

Modify Accounting

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile

Use this API command to modify the accounting settings of a WLAN.

RequestShowHide

Body

{
    "throughController" : false,
    "id" : "accountingServiceUUID",
    "name" : "accountingServiceName",
    "interimUpdateMin" : 10,
    "accountingDelayEnabled" : false
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "throughController" : {
            "description" : "Indicates whether accounting messages were sent through the controller",
            "type" : "boolean"
        },
        "id" : {
            "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
            "type" : "string"
        },
        "name" : {
            "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
            "type" : "string"
        },
        "interimUpdateMin" : {
            "description" : "Interval (in minutes) for sending interim updates",
            "type" : "integer",
            "minimum" : 0,
            "maximum" : 1440
        },
        "accountingDelayEnabled" : {
            "description" : "Indicates whether accounting delay time is enabled",
            "type" : "boolean"
        }
    },
    "description" : "Accounting of the WLAN"
}

Response 204

Disable Accounting

DELETE

/v2_1/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile

Use this API command to disable the accounting of a WLAN.

Response 204

Modify Encryption

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/encryption

Use this API command to modify the encryption settings of a WLAN.

RequestShowHide

Body

{
    "method" : "WPA2",
    "algorithm" : "AES",
    "passphrase" : "password"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "method" : {
            "description" : "Encryption method",
            "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
        },
        "algorithm" : {
            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
            "enum" : [ "AES", "TKIP_AES" ]
        },
        "passphrase" : {
            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
            "type" : "string"
        },
        "mfp" : {
            "description" : "Management frame protection. This only applies to WPA2 + AES",
            "enum" : [ "disabled", "capable", "required" ]
        },
        "keyIndex" : {
            "description" : "Key index. This only applies to WEP64 and WEP128.",
            "type" : "integer"
        },
        "keyInHex" : {
            "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
            "type" : "string"
        }
    },
    "required" : [ "method" ],
    "description" : "Encryption of the WLAN"
}

Response 204

Modify Portal Profile

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/portalServiceProfile

Use this API command to modify the portal configuration of a WLAN.

RequestShowHide

Body

{
    "id" : "portalServiceUUID",
    "name" : "portalServiceName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
}

Response 204

Modify Hotspot20 Profile

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/hotspot20Profile

Use this API command to modify the Hotspot 2.0 profile configuration of a WLAN.

RequestShowHide

Body

{
    "id" : "hotspot20ServiceUUID",
    "name" : "hotspot20ServiceName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
}

Response 204

Modify User Traffic Profile

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/defaultUserTrafficProfile

Use this API command to modify the user traffic profile configuration of a WLAN.

RequestShowHide

Body

{
    "id" : "userTrafficUUID",
    "name" : "userTrafficName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "User traffic profile of the WLAN"
}

Response 204

Modify Schedule

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/schedule

Use this API command to modify the schedule configuration of a WLAN.

RequestShowHide

Body

{
    "type" : "Customized",
    "id" : "ServiceUUID",
    "name" : "ServiceName"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "type" : {
            "description" : "Type of WLAN schedule",
            "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
        },
        "id" : {
            "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
            "type" : "string"
        }
    },
    "required" : [ "type" ],
    "description" : "Schedule of the WLAN"
}

Response 204

Modify VLAN

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/vlan

Use this API command to modify the VLAN configuration of a WLAN.

RequestShowHide

Body

{
    "accessVlan" : 23,
    "dynamicVlanEnabled" : true
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "accessVlan" : {
            "description" : "Access VLAN ID",
            "type" : "integer",
            "minimum" : 1,
            "maximum" : 4094
        },
        "dynamicVlanEnabled" : {
            "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
            "type" : "boolean"
        },
        "vlanPooling" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Vlan pooling"
        }
    },
    "description" : "VLAN (access and/or core) of the WLAN."
}

Response 204

Modify Layer 2 ACL

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/l2ACL

Use this API command to modify the layer 2 access control list (ACL) configuration of a WLAN.

RequestShowHide

Body

{
    "id" : "l2ACLUUID",
    "name" : "l2ACLName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Layer 2 ACL of the WLAN"
}

Response 204

Disable Layer 2 ACL

DELETE

/v2_1/rkszones/{zoneId}/wlans/{id}/l2ACL

Use this API command to disable the layer 2 access control list (ACL) configuration of a WLAN.

Response 204

Modify Device Policy

PATCH

/v2_1/rkszones/{zoneId}/wlans/{id}/devicePolicy

Use this API command to modify the device policy of a WLAN.

RequestShowHide

Body

{
    "id" : "devicePolicyUUID",
    "name" : "devicePolicyName"
}

Schema

{
    "type" : [ "object", "null" ],
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string"
        }
    },
    "description" : "Device policy of the WLAN"
}

</

Overview

Common Request Header

HTTP Responses

Successful Requests

Failed Requests

Errors

Ruckus Wireless Error Codes

Change Logs

Login Session

Logon

Body

Schema

Body

Schema

Logoff

Retrieve

Body

Schema

Ruckus Wireless AP Zone

Retrieve List

Body

Schema

Retrieve

Body

Schema

Retrieve Mesh Configuration

Body

Schema

Modify Mesh Configuration

Body

Schema

Create Zone

Body

Schema

Body

Schema

Create Zone of IPv6

Body

Schema

Body

Schema

Modify Basic

Body

Schema

Modify Time Zone

Body

Schema

Modify AP Logon

Body

Schema

Modify Radio 2.4G

Body

Schema

Modify Radio 5G

Body

Schema

Modify Syslog

Body

Schema

Disable Syslog

Modify Smart Monitor

Body

Schema

Disable Smart Monitor

Modify Client Admission Control 2.4G

Body

Schema

Disable Client Admission Control 2.4G

Modify Client Admission Control 5G

Body

Schema

Disable Client Admission Control 5G

Modify Tunnel Profile

Body

Schema

Modify Background Scanning 2.4G

Body

Schema

Disable Background Scanning 2.4G

Modify Background Scanning 5G