Back to top

Virtual SmartZone (Essentials) Public API Reference Guide

Overview

This reference guide describes the public APIs supported by the Virtual SmartZone (Essentials). 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}:8443/wsg/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

Not Support URIs

Due to the features have been changed the design. There below URIs are no longer support in all API version as below :

Enterprise Tunnel Profile
GET /profiles/enterpriseTunnel
PATCH /profiels/enterpriseTunnel
PATCH /rkszones/{id}/enterpriseZoneTunnelConfig
Application Visibility Control
· User Defined Roles
GET /rkszones/{zoneId}/profile/avc/userDefined
GET /rkszones/{zoneId}/profile/avc/userDefined/{id}
DELETE /rkszones/{zoneId}/profile/avc/userDefined/{id}
POST /rkszones/{zoneId}/profile/avc/userDefined
PATCH /rkszones/{zoneId}/profile/avc/userDefined/{id}
· Port Mapping
GET /rkszones/{zoneId}/profile/avc/portMapping
GET /rkszones/{zoneId}/profile/avc/portMapping/{id}
DELETE /rkszones/{zoneId}/profile/avc/portMapping/{id}
PATCH /rkszones/{zoneId}/profile/avc/portMapping
PATCH /rkszones/{zoneId}/profile/avc/portMapping/{id}
· Denial Policy
GET /rkszones/{zoneId}/profile/avc/denialPolicy
GET /rkszones/{zoneId}/profile/avc/denialPolicy/{id}
DELETE /rkszones/{zoneId}/profile/avc/denialPolicy/{id}
POST /rkszones/{zoneId}/profile/avc/denialPolicy
PATCH /rkszones/{zoneId}/profile/avc/denialPolicy/{id}

Usage for Query Criteria

For further information on how to use the query criteria. Please click the link for the detail.

Change Logs

  • What’s New

    • Ruckus Wireless AP Zone
      • Create Zone of IPv6
      • Create Zone of Dual
      • Retrieve AP Model Common Attribute
    • WLAN
      • Create - 802.1X
      • Modify External DPSK Setting
    • WLAN Scheduler
      • Modify Schedules On Sunday
      • Modify Schedules On Monday
      • Modify Schedule On Tuesday
      • Modify Schedule On Wednesday
      • Modify Schedules On Thursday
      • Modify Schedules On Friday
      • Modify Schedules On Saturday
    • Bonjour Gateway Policies
      • Retrieve list
      • Retrieve
      • Create
      • Modify Basic
      • Modify bonjour gateway policy rule list
      • Modify Enable
      • Delete
    • Flexi-VPN
      • Retrive Flexi-VPN global configuration
      • Modify Flexi-VPN global configuration
      • Update Flexi-VPN profile
      • Delete Flexi-VPN profile on specific WLAN
      • Query Flexi-VPN Profiles
    • Wired Client
      • Query Wired Clients
  • What’s Remove

  • What’s Deprecated

    • WLAN
      • Create - 802.1X - Deprecated
    • Access Point Configuration
      • Modify AP Picture
    • Access Point Operational
      • Retrieve Rogue AP List
    • Zone AAA
      • Retrieve List - RADIUS Accounting
      • Retrieve - RADIUS Accounting
      • Create - RADIUS Accounting
      • Modify - RADIUS Accounting
      • Modify - Primary Server of RADIUS Accounting
      • Modify - Secondary Server of RADIUS Accounting
      • Disable Secondary Server - RADIUS Accounting
      • Delete - RADIUS Accounting
    • Application Log And Status
      • Get control plane list
    • Bonjour Gateway Policies
      • Retrieve list
      • Retrieve
      • Create
      • Modify Basic
      • Modify bonjour gateway policy rule list
      • Modify Enable
      • Delete
  • Changes

    • Ruckus Wireless AP Zone
      • Create Zone
        • attributes added (timezone,mesh,dfsChannelEnabled,wifi24,wifi50,syslog,smartMonitor,clientAdmissionControl24,clientAdmissionControl50,channelModeEnabled,tunnelType,tunnelProfile,backgroundScanning24,backgroundScanning50,clientLoadBalancing24,clientLoadBalancing50,bandBalancing,rogue,dosBarringEnable,dosBarringPeriod,dosBarringThreshold,dosBarringCheckPeriod,locationBasedService,apRebootTimeout,location,locationAdditionalInfo,altitude,latitude,longitude,vlanOverlappingEnabled,nodeAffinityProfile,venueProfile,usbSoftwarePackage,autoChannelSelection24,autoChannelSelection50,channelEvaluationInterval,apMgmtVlan,ipsecProfile,ipv6TrafficFilterEnabled,bonjourFencingPolicyEnabled,bonjourFencingPolicy,dhcpSiteConfig,snmpAgent,recoverySsid)
    • Hotspot Service
      • Retrieve
        • attributes added (httpsRedirect)
      • Create Internal
        • attributes added (httpsRedirect)
      • Create External
        • attributes added (httpsRedirect)
      • Modify
        • attributes added (httpsRedirect)
      • Create Smart Client Only
        • attributes added (httpsRedirect)
    • WLAN
      • Create - Web Auth
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,operatorRealm,accountingServiceOrProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Create - Hotspot + MAC bypass
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,operatorRealm,accountingServiceOrProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Create - Guest Access
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,operatorRealm,accountingServiceOrProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Create - MAC Auth
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,operatorRealm,accountingServiceOrProfile,portalServiceProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Create - Standard Open
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,authServiceOrProfile,operatorRealm,accountingServiceOrProfile,portalServiceProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Create - 802.1X - Deprecated
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,operatorRealm,accountingServiceOrProfile,portalServiceProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Modify
        • attributes added (externalDpsk)
      • Create - Wechat
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,authServiceOrProfile,operatorRealm,accountingServiceOrProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Create - Hotspot 2.0 OSEN
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,authServiceOrProfile,operatorRealm,accountingServiceOrProfile,portalServiceProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Create - Hotspot 2.0
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,authServiceOrProfile,operatorRealm,accountingServiceOrProfile,portalServiceProfile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
      • Create - Hotspot
        • attributes added (bypassCNA,caleaEnabled,dpTunnelNatEnabled,awsExtNasIPEnable,awsVenueEnable,accessTunnelType,coreTunnelProfile,macAuth,encryption,operatorRealm,accountingServiceOrProfile,hotspot20Profile,defaultUserTrafficProfile,schedule,vlan,l2ACL,devicePolicy,radiusOptions,advancedOptions,diffServProfile,qosMaps,dpsk,externalDpsk,dnsServerProfile)
    • DHCP
      • Get AP DHCP Pool Usage by pool’s index.
        • attributes added (name,poolStartIp,poolEndIp,subnetMask)
  • Backward Compatible Notice

Login Session

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

Logon

POST/v5_1/session

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

Request
HideShow
Body
{
  "username": "admin",
  "password": "admin!234",
  "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": "DEPRECATED. 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  200
HideShow
Body
{
  "controllerVersion": "1"
}
Schema
{
  "type": "object",
  "properties": {
    "controllerVersion": {
      "type": "string"
    }
  }
}

Logoff

DELETE/v5_1/session

Use this API command to log off of the controller.

Response  200

Retrieve

GET/v5_1/session

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

Response  200
HideShow
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/v5_1/rkszones

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

URI Parameters
HideShow
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  200
HideShow
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"
          },
          "serviceName": {
            "description": "Name of the zone",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v5_1/rkszones/{id}

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

Response  200
HideShow
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,
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "syslog": null,
  "smartMonitor": null,
  "clientAdmissionControl24": null,
  "clientAdmissionControl50": null,
  "channelModeEnabled": false,
  "tunnelType": "SoftGREIpsec",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "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",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "autoPurgeExpiredDpsk": "OneDay",
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "recoverySsid": {
    "recoverySsidEnable": 1,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "zoneName": "zoneK",
    "siteEnabled": true,
    "manualSelect": true,
    "siteMode": "EnableOnMultipleAPs",
    "siteAps": [
      {
        "apMac": "38:FF:36:00:0E:10",
        "apServerEnabled": true,
        "apServerPrimary": true
      },
      {
        "apMac": "58:FF:36:00:0E:20",
        "apServerEnabled": true,
        "apServerPrimary": false
      }
    ],
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan 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."
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "description" : "client load balancing on Radio 5G, auto channel selection mode"
        },
        "awsVenue" : {
            "description" : "venue code",
            "type" : "string"
        },
        "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."
        },
        "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."
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour Fencing Policy on the AP"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "default" : 600,
            "description" : "channel evaluation Interval of the zone",
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "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."
        },
        "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."
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64,
            "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description" : "Description of the zone"
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "DHCP Site Config in Zone"
        },
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "id" : {
            "description" : "Identifier of the zone",
            "type" : "string"
        },
        "ipMode" : {
            "enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ],
            "description" : "IP mode of the zone"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number",
            "description" : "Latitude coordinate (in decimal format) 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."
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Location based service configuration of the 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"
        },
        "longitude" : {
            "type" : "number",
            "description" : "Longitude coordinate (in decimal format) 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."
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
            "description" : "Name of the zone"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Node affinity profile 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."
        },
        "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."
        },
        "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."
        },
        "timezone" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                }
            },
            "type" : "object",
            "description" : "Time zone"
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "tunnel type configuration of the Zone."
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "usbSoftwarePackage" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "APUsbSoftwarePackage id or name"
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "APUsbSoftwarePackage of the zone"
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "venue profile configuration of the Zone."
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
            "description" : "AP firmware version of the zone"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "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. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableIndoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableOutdoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "description" : "AP 5GHz radio configuration of the zone."
        },
        "zoneAffinityProfileId" : {
            "description" : "zone affinity profile Id",
            "type" : "string"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            },
            "description" : "AP SNMP Options"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            },
            "description" : "Recovery SSID"
        }
    },
    "type" : "object"
}

Create Zone

POST/v5_1/rkszones

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

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnable": 1,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "multiSample": [
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs",
        "sampleJson": {
          "siteEnabled": true,
          "siteMode": "EnableOnEachAPs",
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      },
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs",
        "sampleJson": {
          "siteEnabled": true,
          "manualSelect": true,
          "siteMode": "EnableOnMultipleAPs",
          "siteAps": [
            {
              "apMac": "38:FF:36:00:0E:10",
              "apServerEnabled": true,
              "apServerPrimary": true
            },
            {
              "apMac": "58:FF:36:00:0E:20",
              "apServerEnabled": true,
              "apServerPrimary": false
            }
          ],
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      }
    ]
  }
}
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"
        },
        "timezone" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                }
            },
            "type" : "object",
            "description" : "Either systemTimezone or customizedTimezone must be specified"
        },
        "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."
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "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. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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 is for IPv6 mode",
            "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."
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "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."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "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."
        },
        "usbSoftwarePackage" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "APUsbSoftwarePackage id or name"
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "APUsbSoftwarePackage of the zone"
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the zone"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour Fencing Policy on the AP"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "DHCP Site Configuration in Zone"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            },
            "description" : "AP SNMP Options"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            },
            "description" : "Recovery SSID"
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the zone",
      "type": "string"
    }
  }
}

Create Zone of IPv6

POST/v5_1/rkszones/ipv6

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

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnable": 1,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "multiSample": [
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs",
        "sampleJson": {
          "siteEnabled": true,
          "siteMode": "EnableOnEachAPs",
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      },
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs",
        "sampleJson": {
          "siteEnabled": true,
          "manualSelect": true,
          "siteMode": "EnableOnMultipleAPs",
          "siteAps": [
            {
              "apMac": "38:FF:36:00:0E:10",
              "apServerEnabled": true,
              "apServerPrimary": true
            },
            {
              "apMac": "58:FF:36:00:0E:20",
              "apServerEnabled": true,
              "apServerPrimary": false
            }
          ],
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      }
    ]
  }
}
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"
        },
        "timezone" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                }
            },
            "type" : "object",
            "description" : "Either systemTimezone or customizedTimezone must be specified"
        },
        "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."
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "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. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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 is for IPv6 mode",
            "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."
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "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."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "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."
        },
        "usbSoftwarePackage" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "APUsbSoftwarePackage id or name"
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "APUsbSoftwarePackage of the zone"
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the zone"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour Fencing Policy on the AP"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "DHCP Site Configuration in Zone"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            },
            "description" : "AP SNMP Options"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            },
            "description" : "Recovery SSID"
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the zone",
      "type": "string"
    }
  }
}

Create Zone of Dual

POST/v5_1/rkszones/dual

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

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnable": 1,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "multiSample": [
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs",
        "sampleJson": {
          "siteEnabled": true,
          "siteMode": "EnableOnEachAPs",
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      },
      {
        "sampleDescription": "DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs",
        "sampleJson": {
          "siteEnabled": true,
          "manualSelect": true,
          "siteMode": "EnableOnMultipleAPs",
          "siteAps": [
            {
              "apMac": "38:FF:36:00:0E:10",
              "apServerEnabled": true,
              "apServerPrimary": true
            },
            {
              "apMac": "58:FF:36:00:0E:20",
              "apServerEnabled": true,
              "apServerPrimary": false
            }
          ],
          "siteProfileIds": [
            "75e26590-547f-11e6-9ca7-5a095364c13c",
            "869bb532-547f-11e6-9ca7-5a095364c13c"
          ]
        }
      }
    ]
  }
}
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"
        },
        "timezone" : {
            "additionalProperties" : false,
            "properties" : {
                "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"
                }
            },
            "type" : "object",
            "description" : "Either systemTimezone or customizedTimezone must be specified"
        },
        "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."
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "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. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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 is for IPv6 mode",
            "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."
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "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."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "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."
        },
        "usbSoftwarePackage" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    },
                    "description" : "APUsbSoftwarePackage id or name"
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "APUsbSoftwarePackage of the zone"
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the zone"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "ipsec profile configuration of the Zone."
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            },
            "description" : "Bonjour Fencing Policy on the AP"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            },
            "description" : "DHCP Site Configuration in Zone"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            },
            "description" : "AP SNMP Options"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            },
            "description" : "Recovery SSID"
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the zone",
      "type": "string"
    }
  }
}

Delete

DELETE/v5_1/rkszones/{id}

Use this API command to delete a zone.

Response  204

Retrieve Mesh Configuration

GET/v5_1/rkszones/{id}/mesh

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

Response  200
HideShow
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/v5_1/rkszones/{id}/mesh

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

Request
HideShow
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

Clear Mesh Configuration

DELETE/v5_1/rkszones/{id}/mesh

Use this API command to disable mesh networking.

Response  204

Modify Basic

PATCH/v5_1/rkszones/{id}

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

Request
HideShow
Body
{
  "bonjourFencingPolicyEnabled": true,
  "channelEvaluationInterval": 777,
  "channelModeEnabled": false,
  "countryCode": "US",
  "description": "description modified",
  "dfsChannelEnabled": false,
  "domainId": "domainUUIDToMove",
  "ipv6TrafficFilterEnabled": 0,
  "latitude": 23,
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "longitude": 23,
  "name": "zoneModified",
  "tunnelType": "RuckusGRE",
  "vlanOverlappingEnabled": false
}
Schema
{
  "awsVenue": {
    "description": "venue code",
    "type": "string"
  },
  "bonjourFencingPolicyEnabled": {
    "description": "Enable Bonjour Fencing Policy on the AP",
    "type": "boolean"
  },
  "channelEvaluationInterval": {
    "default": 600,
    "description": "channel evaluation Interval of the zone",
    "maximum": 3600,
    "minimum": 60,
    "type": "integer"
  },
  "channelModeEnabled": {
    "description": "Channel mode configuration of the zone.",
    "type": "boolean"
  },
  "countryCode": {
    "description": "Country code of the zone",
    "type": "string"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the zone"
  },
  "dfsChannelEnabled": {
    "description": "DFS Channel enabled configuration of the zone, only for the US country code .",
    "type": "boolean"
  },
  "domainId": {
    "description": "Identifier of the management domain to which the zone belongs",
    "type": "string"
  },
  "dosBarringCheckPeriod": {
    "description": "DoS Protection(Barring UE) check period of the zone.",
    "type": "integer"
  },
  "dosBarringEnable": {
    "description": "Enable DoS Protection(Barring UE) of the zone.",
    "type": "integer"
  },
  "dosBarringPeriod": {
    "description": "DoS Protection(Barring UE) blocking period of the zone.",
    "type": "integer"
  },
  "dosBarringThreshold": {
    "description": "DoS Protection(Barring UE) threshold of the zone.",
    "type": "integer"
  },
  "ipv6TrafficFilterEnabled": {
    "description": "IPv6 Traffic filtering on the AP",
    "type": "integer"
  },
  "latitude": {
    "type": "number",
    "description": "Latitude coordinate (in decimal format) 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."
  },
  "longitude": {
    "type": "number",
    "description": "Longitude coordinate (in decimal format) of the zone"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the zone"
  },
  "tunnelType": {
    "description": "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
    "enum": [
      "No_Tunneled",
      "RuckusGRE",
      "SoftGRE",
      "SoftGREIpsec"
    ]
  },
  "vlanOverlappingEnabled": {
    "description": "VLAN pooling overlapping of the zone",
    "type": "boolean"
  },
  "zoneAffinityProfileId": {
    "description": "zone affinity profile Id",
    "type": "string"
  }
}
Response  204

Modify Time Zone

PATCH/v5_1/rkszones/{id}/timezone

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

Request
HideShow
Body
{
  "customizedTimezone": {
    "abbreviation": "ABC",
    "gmtOffset": 4,
    "gmtOffsetMinute": 10
  }
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "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"
    }
  },
  "type": "object",
  "description": "Time zone"
}
Response  204

Follow System Time Zone

DELETE/v5_1/rkszones/{id}/timezone

Use this API command to reset the time zone with system time zone of a zone.

Response  204

Modify AP Logon

PATCH/v5_1/rkszones/{id}/login

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

Request
HideShow
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/v5_1/rkszones/{id}/wifi24

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

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 0,
  "channelRange": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    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. Zero (0) means Auto.",
      "enum": [
        0,
        20,
        40
      ]
    },
    "channel": {
      "description": "Channel number",
      "type": "integer"
    },
    "channelRange": {
      "description": "Channel range options",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "AP 2.4GHz radio configuration of the zone."
}
Response  204

Modify Radio 5G

PATCH/v5_1/rkszones/{id}/wifi50

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

Request
HideShow
Body
{
  "txPower": "-1dB",
  "channelWidth": 40,
  "indoorChannel": 0,
  "outdoorChannel": 0,
  "indoorChannelRange": [
    36,
    40,
    44,
    48,
    149,
    153,
    157,
    161
  ],
  "outdoorChannelRange": [
    149,
    153,
    157,
    161
  ]
}
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. 8080 means 80+80MHz",
      "enum": [
        0,
        20,
        40,
        80,
        8080,
        160
      ]
    },
    "indoorChannel": {
      "description": "Channel number for Indoor AP",
      "type": "integer"
    },
    "outdoorChannel": {
      "description": "Channel number for Outdoor AP",
      "type": "integer"
    },
    "indoorSecondaryChannel": {
      "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "outdoorSecondaryChannel": {
      "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "indoorChannelRange": {
      "description": "Channel range options for Indoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "outdoorChannelRange": {
      "description": "Channel range options for outdoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "AP 5GHz radio configuration of the zone."
}
Response  204

Modify Syslog

PATCH/v5_1/rkszones/{id}/syslog

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

Request
HideShow
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/v5_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/v5_1/rkszones/{id}/smartMonitor

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

Request
HideShow
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/v5_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/v5_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.

Request
HideShow
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/v5_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/v5_1/rkszones/{id}/clientAdmissionControl50

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

Request
HideShow
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/v5_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 Background Scanning 2.4G

PATCH/v5_1/rkszones/{id}/backgroundScanning24

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

Request
HideShow
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/v5_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/v5_1/rkszones/{id}/backgroundScanning50

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

Request
HideShow
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/v5_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/v5_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.

Request
HideShow
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/v5_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/v5_1/rkszones/{id}/clientLoadBalancing50

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

Request
HideShow
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/v5_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/v5_1/rkszones/{id}/bandBalancing

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

Request
HideShow
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/v5_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/v5_1/rkszones/{id}/apRebootTimeout

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

Request
HideShow
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/v5_1/rkszones/{id}/nodeAffinityProfile

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

Request
HideShow
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/v5_1/rkszones/{id}/venueProfile

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

Request
HideShow
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/v5_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/v5_1/rkszones/{id}/rogue

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

Request
HideShow
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/v5_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/v5_1/rkszones/{id}/locationBasedService

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

Request
HideShow
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/v5_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/v5_1/rkszones/{zoneId}/apmodel/{model}

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

Response  200
HideShow
Body
{
  "ledStatusEnabled": true,
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
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"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "enum": [
        null,
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus"
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "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"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}

Modify AP Model

PUT/v5_1/rkszones/{zoneId}/apmodel/{model}

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

Request
HideShow
Body
{
  "ledStatusEnabled": true,
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
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"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "enum": [
        null,
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus"
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "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"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}
Response  204

Retrieve AP Model Common Attribute

GET/v5_1/rkszones/{zoneId}/apmodel/{model}/commonAttribute

Use this API command to retrieve AP model common attribute that belong to a zone.

Response  200
HideShow
Body
{
  "nonEditablePorts": [
    2
  ],
  "isAllowDisableExtAnt": null,
  "nonVisiblePorts": [
    2
  ],
  "hasScanRadio": null,
  "hasCablemodem": true,
  "hasGps": false,
  "isDualRadio": true,
  "isOutdoor": false,
  "maxChannelization24G": 40,
  "maxChannelization5G": 80,
  "maxClientsUpper": 256,
  "maxWlanNum24G": 15,
  "maxWlanNum5G": 16,
  "noAvc": false,
  "noMesh": false,
  "reserved5GWlanForMesh": 3,
  "support11AC": true,
  "supportChannelization160": null,
  "supportAPUsbSoftwarePackage": null,
  "supportBandSwitch": false,
  "supportBonjour": true,
  "supportIpsec": false,
  "supportLBS": true,
  "supportResetCablemodem": true,
  "allowDfsCountry": "US",
  "ram": 512,
  "numOfCores": 4,
  "cpuFrequency": 600,
  "scalingFactor": 1,
  "capabilityScore": 75
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "nonEditablePorts": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "isAllowDisableExtAnt": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "nonVisiblePorts": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "hasScanRadio": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "hasCablemodem": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "hasGps": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "isDualRadio": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "isOutdoor": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "maxChannelization24G": {
      "type": "integer"
    },
    "maxChannelization5G": {
      "type": "integer"
    },
    "maxClientsUpper": {
      "type": "integer"
    },
    "maxWlanNum24G": {
      "type": "integer"
    },
    "maxWlanNum5G": {
      "type": "integer"
    },
    "noAvc": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "noMesh": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "reserved5GWlanForMesh": {
      "type": "integer"
    },
    "support11AC": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportChannelization160": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportAPUsbSoftwarePackage": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportBandSwitch": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportBonjour": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportIpsec": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportLBS": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportResetCablemodem": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "allowDfsCountry": {
      "type": "string"
    },
    "ram": {
      "type": "integer"
    },
    "numOfCores": {
      "type": "integer"
    },
    "cpuFrequency": {
      "type": "integer"
    },
    "scalingFactor": {
      "type": "integer"
    },
    "capabilityScore": {
      "type": "number"
    }
  }
}

Modify Radio 2.4G Auto ChannelSelectMode

PATCH/v5_1/rkszones/{id}/autoChannelSelection24

Modify Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of a zone.

Request
HideShow
Body
{
  "channelSelectMode": "ChannelFly",
  "channelFlyMtbc": 480
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "channelSelectMode": {
      "description": "Channel Select Mode",
      "enum": [
        "None",
        "BackgroundScanning",
        "ChannelFly"
      ]
    },
    "channelFlyMtbc": {
      "description": "ChannelFly MTBC",
      "type": "integer",
      "default": 480,
      "minimum": 100,
      "maximum": 1440
    }
  },
  "description": "client load balancing on Radio 2.4G, auto channel selection mode"
}
Response  204

Modify Radio 5G Auto ChannelSelectMode

PATCH/v5_1/rkszones/{id}/autoChannelSelection50

Modify Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of a zone.

Request
HideShow
Body
{
  "channelSelectMode": "BackgroundScanning",
  "channelFlyMtbc": 480
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "channelSelectMode": {
      "description": "Channel Select Mode",
      "enum": [
        "None",
        "BackgroundScanning",
        "ChannelFly"
      ]
    },
    "channelFlyMtbc": {
      "description": "ChannelFly MTBC",
      "type": "integer",
      "default": 480,
      "minimum": 100,
      "maximum": 1440
    }
  },
  "description": "client load balancing on Radio 5G, auto channel selection mode"
}
Response  204

Modify IPsec Profile

PATCH/v5_1/rkszones/{id}/ipsecProfile

Modify IPsec Profile of a zone.

Request
HideShow
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

Modify AP Usb Software Package

PATCH/v5_1/rkszones/{id}/usbSoftwarePackage

Modify AP Usb Software Package of a zone.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "usbSoftware": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "APUsbSoftwarePackage id or name"
    },
    "applyModel": {
      "description": "List of apply models",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "APUsbSoftwarePackage of the zone"
}
Response  204

Modify AP Management Vlan

PATCH/v5_1/rkszones/{id}/apMgmtVlan

Modify AP Management Vlan of a zone.

Request
HideShow
Body
{
  "id": 1,
  "mode": "KEEP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mode": {
      "description": "Vlan Mode of the zone",
      "enum": [
        "KEEP",
        "USER_DEFINED"
      ]
    },
    "id": {
      "description": "Vlan id of the zone",
      "type": "integer"
    }
  },
  "description": "ap Management Vlan of the zone"
}
Response  204

Disable AP Usb Software Package

DELETE/v5_1/rkszones/{id}/usbSoftwarePackage

Disable AP Usb Software Package of a zone.

URI Parameters
HideShow
applyModel
string (optional) 

Specify ap models. ex : applyModel=ZF7321U&applyModel=ZF7323

Response  204

Modify Altitude

PATCH/v5_1/rkszones/{id}/altitude

Use this API command to modify the altitude configuration of zone.

Request
HideShow
Body
{
  "altitudeUnit": "meters",
  "altitudeValue": 1
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "altitudeUnit": {
      "description": "altitude unit",
      "enum": [
        "meters",
        "floor"
      ]
    },
    "altitudeValue": {
      "description": "altitude value",
      "type": "integer"
    }
  },
  "description": "GPS Altitude"
}
Response  204

Disable Altitude

DELETE/v5_1/rkszones/{id}/altitude

Use this API command to disable altitude configuration of zone.

Response  204

Retrieve AP Firmware List

GET/v5_1/rkszones/{zoneId}/apFirmware

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

Response  200
HideShow
Body
[
  {
    "firmwareVersion": "3.4.0.101.492",
    "unsupportedApModelSummary": [
      {
        "model": "R300",
        "amount": 1
      }
    ],
    "supported": false
  },
  {
    "firmwareVersion": "3.4.0.101.505",
    "unsupportedApModelSummary": [],
    "supported": true
  }
]
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "firmwareVersion": {
            "description": "version of the AP firmare",
            "type": "string"
          },
          "unsupportedApModelSummary": {
            "description": "summary of the AP Model is unsupported for AP firmware version.",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "model": {
                  "description": "name of the AP Model",
                  "type": "string"
                },
                "amount": {
                  "description": "amount of the AP Model",
                  "type": "integer"
                }
              }
            }
          },
          "supported": {
            "description": "version of the AP firmare is supported for Upgrade or Downgrade.",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Change AP Firmware

PUT/v5_1/rkszones/{zoneId}/apFirmware

Use this API command to change the AP Firmware that belong to a zone.

Request
HideShow
Body
{
  "firmwareVersion": "3.4.0.101.25"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "firmwareVersion": {
      "description": "new version of the AP firmare",
      "type": "string"
    }
  }
}
Response  204

Modify AP SNMP Options

PATCH/v5_1/rkszones/{id}/snmpAgent

Use this API command to modify SNMPv2 and SNMPv3 agent that belong to a zone.

Request
HideShow
Body
{
  "apSnmpEnabled": true,
  "snmpV2Agent": [
    {
      "communityName": "v2Agent",
      "notificationEnabled": true,
      "readEnabled": true,
      "writeEnabled": true,
      "notificationType": "TRAP",
      "notificationTarget": [
        {
          "address": "172.19.16.20",
          "port": 161
        }
      ]
    }
  ],
  "snmpV3Agent": [
    {
      "userName": "v3Agent",
      "authProtocol": "MD5",
      "authPassword": "admin!234",
      "privProtocol": "DES",
      "privPassword": "admin!234",
      "notificationEnabled": true,
      "readEnabled": true,
      "writeEnabled": true,
      "notificationType": "TRAP",
      "notificationTarget": [
        {
          "address": "172.19.16.20",
          "port": 161
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apSnmpEnabled": {
      "description": "Enable AP SNMP",
      "type": "boolean"
    },
    "snmpV2Agent": {
      "description": "Community List of the SNMP V2 Agent.",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "communityName": {
            "description": "name of the SNMP Community.",
            "type": "string"
          },
          "readEnabled": {
            "description": "read privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "writeEnabled": {
            "description": "write privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "notificationEnabled": {
            "description": "notification privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "notificationType": {
            "description": "type of the notification privilege",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "description": "Trap List of the SNMP Coummunity",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "description": "address of the SNMP Trap",
                  "type": "string"
                },
                "port": {
                  "description": "port number of the SNMP Trap",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "communityName"
        ]
      }
    },
    "snmpV3Agent": {
      "description": "User List of the SNMP V3 Agent.",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "userName": {
            "description": "name of the SNMP User.",
            "type": "string"
          },
          "authProtocol": {
            "description": "authProtocol of the SNMP User.",
            "enum": [
              "NONE",
              "MD5",
              "SHA"
            ]
          },
          "authPassword": {
            "description": "authPassword of the SNMP User.",
            "type": "string",
            "minLength": 8
          },
          "privProtocol": {
            "description": "privProtocol of the SNMP User.",
            "enum": [
              "NONE",
              "DES",
              "AES"
            ]
          },
          "privPassword": {
            "description": "privPassword of the SNMP User.",
            "type": "string",
            "minLength": 8
          },
          "readEnabled": {
            "description": "read privilege of the SNMP User",
            "type": "boolean"
          },
          "writeEnabled": {
            "description": "write privilege of the SNMP User",
            "type": "boolean"
          },
          "notificationEnabled": {
            "description": "notification privilege of the SNMP User",
            "type": "boolean"
          },
          "notificationType": {
            "description": "type of the notification privilege",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "description": "Trap List of the SNMP User",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "description": "address of the SNMP Trap",
                  "type": "string"
                },
                "port": {
                  "description": "port number of the SNMP Trap",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "userName"
        ]
      }
    }
  },
  "description": "AP SNMP Options"
}
Response  204

Clear AP SNMP Options

DELETE/v5_1/rkszones/{id}/snmpAgent

Use this API command to clear SNMPv2 and SNMPv3 agent that belong to a zone.

Response  204

Modify zone recovery SSID

PATCH/v5_1/rkszones/{id}/recoverySsid

Modify recovery ssid setting of a zone (setup a password, or enable/disable).

Request
HideShow
Body
{
  "recoverySsidEnable": 1,
  "recoverySsidPskKey": "556612345"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "recoverySsidPskKey": {
      "description": "recovery ssid password",
      "type": "string"
    },
    "recoverySsidEnabled": {
      "description": "recovery ssid enable/disable",
      "type": "boolean"
    }
  },
  "description": "Recovery SSID"
}
Response  204

Disable zone recovery SSID

DELETE/v5_1/rkszones/{id}/recoverySsid

Disable recovery ssid setting of a zone (setup a password, or enable/disable).

Response  204

Modify DHCP/NAT service configuration

PATCH/v5_1/rkszones/{id}/dhcpSiteConfig

Use this API command to modify DHCP/NAT service configuration of Zone.

Request
HideShow
Body
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs
{
    "siteEnabled" : true,
    "siteMode" : "EnableOnEachAPs",
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs
{
    "siteEnabled" : true,
    "manualSelect" : true,
    "siteMode" : "EnableOnMultipleAPs",
    "siteAps" : [ {
        "apMac" : "38:FF:36:00:0E:10",
        "apServerEnabled" : true,
        "apServerPrimary" : true
    }, {
        "apMac" : "58:FF:36:00:0E:20",
        "apServerEnabled" : true,
        "apServerPrimary" : false
    } ],
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "siteEnabled" : {
            "description" : "DHCP Service Enabling Status",
            "type" : "boolean"
        },
        "manualSelect" : {
            "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
            "type" : "boolean"
        },
        "siteMode" : {
            "description" : "DHCP Service mode",
            "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
        },
        "siteAps" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                "additionalProperties" : false,
                "properties" : {
                    "apMac" : {
                        "type" : "string"
                    },
                    "apName" : {
                        "type" : "string"
                    },
                    "apStatus" : {
                        "enum" : [ "Online", "Offline", "Flagged" ]
                    },
                    "apServerEnabled" : {
                        "type" : "boolean"
                    },
                    "apServerPrimary" : {
                        "type" : "boolean"
                    },
                    "apServerIp" : {
                        "type" : [ "string", "null" ]
                    },
                    "apGatewayIp" : {
                        "type" : "string"
                    }
                }
            }
        },
        "siteProfileIds" : {
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        }
    },
    "description" : "DHCP Site Config in Zone"
}
Response  204

Retrieve DHCP/NAT service IP assignment

POST/v5_1/rkszones/{zoneId}/dhcpSite/dhcpSiteConfig/doAssignIp

Use this API command to get the DHCP/NAT service IP assignment when selecting with “Enable on Multiple APs”. In the Manually Select AP mode (the manualSelect is true), the body should contain the selected APs (include the siteAps array). Otherwise, there is no need to include the selected APs in the Auto Select AP mode (see samples).

Request
HideShow
Body
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Manually Select AP
{
    "zoneName" : "zoneK",
    "siteEnabled" : true,
    "manualSelect" : true,
    "siteMode" : "EnableOnMultipleAPs",
    "siteAps" : [ {
        "apMac" : "38:FF:36:00:0E:10",
        "apServerEnabled" : true,
        "apServerPrimary" : true
    }, {
        "apMac" : "58:FF:36:00:0E:20",
        "apServerEnabled" : true,
        "apServerPrimary" : false
    } ],
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Auto Select AP
{
    "zoneName" : "zoneK",
    "siteEnabled" : true,
    "manualSelect" : false,
    "siteMode" : "EnableOnMultipleAPs",
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "siteEnabled" : {
            "description" : "DHCP Service Enabling Status",
            "type" : "boolean"
        },
        "manualSelect" : {
            "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
            "type" : "boolean"
        },
        "siteMode" : {
            "description" : "DHCP Service mode",
            "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
        },
        "siteAps" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                "additionalProperties" : false,
                "properties" : {
                    "apMac" : {
                        "type" : "string"
                    },
                    "apServerEnabled" : {
                        "type" : "boolean"
                    },
                    "apServerPrimary" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "siteProfileIds" : {
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        }
    },
    "description" : "DHCP Service Assign IP For Server and Gateway"
}
Response  200
HideShow
Body
{
  "siteEnabled": true,
  "manualSelect": true,
  "siteMode": "EnableOnMultipleAPs",
  "siteAps": [
    {
      "apMac": "38:FF:36:00:0E:20",
      "apServerEnabled": true,
      "apGatewayEnabled": true
    },
    {
      "apMac": "58:FF:36:00:0E:20",
      "apServerEnabled": true,
      "apGatewayEnabled": true
    }
  ],
  "siteProfiles": [
    "75e26590-547f-11e6-9ca7-5a095364c13c",
    "869bb532-547f-11e6-9ca7-5a095364c13c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "zoneName": {
      "description": "DHCP Service Zone Name",
      "type": "string"
    },
    "siteEnabled": {
      "description": "DHCP Service Enabling Status",
      "type": "boolean"
    },
    "manualSelect": {
      "description": "DHCP Service AP Selection Mode",
      "type": "boolean"
    },
    "siteMode": {
      "description": "DHCP Service mode",
      "enum": [
        "EnableOnEachAPs",
        "EnableOnMultipleAPs"
      ]
    },
    "siteAps": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "DHCP Site selected APs",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "type": "string"
          },
          "apName": {
            "type": "string"
          },
          "apStatus": {
            "enum": [
              "Online",
              "Offline",
              "Flagged"
            ]
          },
          "apServerEnabled": {
            "type": "boolean"
          },
          "apServerPrimary": {
            "type": "boolean"
          },
          "apServerIp": {
            "type": "string"
          },
          "apGatewayIp": {
            "type": "string"
          }
        }
      }
    },
    "siteProfiles": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone Id of DHCP Profile",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the DHCP Profile",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
            "description": "Name of the DHCP Profile"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
            "description": "Description of the DHCP Profile"
          },
          "vlanId": {
            "description": "VLAN ID of the DHCP Profile",
            "type": "integer",
            "minimum": 2,
            "maximum": 4094
          },
          "subnetNetworkIp": {
            "type": "string",
            "description": "Subnet Network IP of the DHCP Profile"
          },
          "subnetMask": {
            "type": "string",
            "description": "Subnet Mask of the DHCP Profile"
          },
          "poolStartIp": {
            "type": "string",
            "description": "Pool Starting IP of the DHCP Profile"
          },
          "poolEndIp": {
            "type": "string",
            "description": "Pool Ending IP of the DHCP Profile"
          },
          "primaryDnsIp": {
            "type": "string",
            "description": "Primany DNS IP of the DHCP Profile"
          },
          "secondaryDnsIp": {
            "type": "string",
            "description": "Secondary DNS IP of the DHCP Profile"
          },
          "leaseTimeHours": {
            "description": "Lease time in hours of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 24
          },
          "leaseTimeMinutes": {
            "description": "Lease time in minutes of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 59
          }
        }
      }
    }
  },
  "description": "DHCP Site Configuration in Zone"
}

Retrieve DHCP/NAT service configuration within Domain

POST/v5_1/rkszones/services/dhcpSiteConfig/query

Use this API command to modify DHCP/NAT service configuration of Domain. Please click the link for the usage of Query Cirteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "ALARMSTATE"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "enum": [
            "insertionTime"
          ]
        }
      },
      "description": "Specified data time range of selection"
    },
    "fullTextSearch": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Specified search string"
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "zoneName": "Default Zone",
      "siteEnabled": false,
      "manualSelect": false,
      "siteMode": "EnableOnEachAPs",
      "siteProfiles": [],
      "siteAps": []
    },
    {
      "zoneName": "zoneK",
      "siteEnabled": true,
      "manualSelect": false,
      "siteMode": "EnableOnEachAPs",
      "siteProfiles": [
        {
          "id": "c1b60951-eeb6-11e6-850a-525400f698b4",
          "zoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
          "name": "P01",
          "description": "",
          "vlanId": 10,
          "subnetNetworkIp": "192.168.10.0",
          "subnetMask": "255.255.255.0",
          "poolStartIp": "192.168.10.1",
          "poolEndIp": "192.168.10.100",
          "primaryDnsIp": "",
          "secondaryDnsIp": "",
          "leaseTimeHours": 0,
          "leaseTimeMinutes": 5
        }
      ],
      "siteAps": [
        {
          "apMac": "EC:8C:A2:01:C5:B0",
          "apServerEnabled": true,
          "apServerPrimary": true,
          "apServerIp": "192.168.10.1",
          "apGatewayIp": "192.168.10.1",
          "apName": "RuckusAP",
          "apStatus": "Offline"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneName": {
            "description": "DHCP Service Zone Name",
            "type": "string"
          },
          "siteEnabled": {
            "description": "DHCP Service Enabling Status",
            "type": "boolean"
          },
          "manualSelect": {
            "description": "DHCP Service AP Selection Mode",
            "type": "boolean"
          },
          "siteMode": {
            "description": "DHCP Service mode",
            "enum": [
              "EnableOnEachAPs",
              "EnableOnMultipleAPs"
            ]
          },
          "siteAps": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "DHCP Site selected APs",
              "additionalProperties": false,
              "properties": {
                "apMac": {
                  "type": "string"
                },
                "apName": {
                  "type": "string"
                },
                "apStatus": {
                  "enum": [
                    "Online",
                    "Offline",
                    "Flagged"
                  ]
                },
                "apServerEnabled": {
                  "type": "boolean"
                },
                "apServerPrimary": {
                  "type": "boolean"
                },
                "apServerIp": {
                  "type": "string"
                },
                "apGatewayIp": {
                  "type": "string"
                }
              }
            }
          },
          "siteProfiles": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "zoneId": {
                  "description": "Zone Id of DHCP Profile",
                  "type": "string"
                },
                "id": {
                  "description": "Identifier of the DHCP Profile",
                  "type": "string"
                },
                "name": {
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 32,
                  "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
                  "description": "Name of the DHCP Profile"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64,
                  "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                  "description": "Description of the DHCP Profile"
                },
                "vlanId": {
                  "description": "VLAN ID of the DHCP Profile",
                  "type": "integer",
                  "minimum": 2,
                  "maximum": 4094
                },
                "subnetNetworkIp": {
                  "type": "string",
                  "description": "Subnet Network IP of the DHCP Profile"
                },
                "subnetMask": {
                  "type": "string",
                  "description": "Subnet Mask of the DHCP Profile"
                },
                "poolStartIp": {
                  "type": "string",
                  "description": "Pool Starting IP of the DHCP Profile"
                },
                "poolEndIp": {
                  "type": "string",
                  "description": "Pool Ending IP of the DHCP Profile"
                },
                "primaryDnsIp": {
                  "type": "string",
                  "description": "Primany DNS IP of the DHCP Profile"
                },
                "secondaryDnsIp": {
                  "type": "string",
                  "description": "Secondary DNS IP of the DHCP Profile"
                },
                "leaseTimeHours": {
                  "description": "Lease time in hours of the DHCP Profile",
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 24
                },
                "leaseTimeMinutes": {
                  "description": "Lease time in minutes of the DHCP Profile",
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 59
                }
              }
            }
          }
        }
      }
    }
  }
}

Modify Bonjour Fencing Policy configuration

PATCH/v5_1/rkszones/{id}/bonjourFencingPolicy

Use this API command to modify Bonjour Fencing Policy configuration of Zone.

Request
HideShow
Body
{
  "id": "bonjourFencingPolicyId",
  "name": "bonjourFencingPolicyName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Bonjour Fencing Policy on the AP"
}
Response  204

Modify tunnel profile

PATCH/v5_1/rkszones/{id}/tunnelProfile

Use this API command to change tunnel profile of Zone.

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

AP Group

Retrieve List

GET/v5_1/rkszones/{zoneId}/apgroups

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

URI Parameters
HideShow
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  200
HideShow
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/v5_1/rkszones/{zoneId}/apgroups/{id}

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

Response  200
HideShow
Body
{
  "id": "apGroupUUID",
  "zoneId": "zoneUUID",
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 9,
    "channelRange": [
      1,
      2,
      3,
      4,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 157,
    "indoorChannelRange": [
      36,
      40,
      44,
      48
    ],
    "outdoorChannelRange": [
      149,
      153
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "wlanGroup24": {
    "id": "19b10850-7eaa-11e4-a584-08002716c79f",
    "name": "default"
  },
  "wlanGroup50": null,
  "locationBasedService": null,
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": null,
  "venueProfile": null,
  "members": [
    {
      "apMac": "00:11:22:33:44:55"
    },
    {
      "apMac": "11:22:33:44:55:66"
    }
  ],
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  }
}
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."
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            },
            "description" : "GPS Altitude"
        },
        "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. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableIndoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableOutdoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            },
            "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])|(\d+)$",
                        "description" : "MAC address of member AP"
                    }
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            },
            "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
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            },
            "description" : "ap Management Vlan of the apgroup"
        },
        "awsVenue" : {
            "description" : "Venue code",
            "type" : "string"
        }
    },
    "required" : [ "name" ]
}

Create

POST/v5_1/rkszones/{zoneId}/apgroups

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

Request
HideShow
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  201
HideShow
Body
{
  "id": "apGroupUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the AP group",
      "type": "string"
    }
  }
}

Modify Basic

PATCH/v5_1/rkszones/{zoneId}/apgroups/{id}

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

Request
HideShow
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
  },
  "awsVenue": {
    "description": "Venue code",
    "type": "string"
  }
}
Response  204

Retrieve

GET/v5_1/rkszones/{zoneId}/apgroups/default

Use this API command to retrieve information about default AP group of zone.

Response  200
HideShow
Body
{
  "id": "apGroupUUID",
  "zoneId": "zoneUUID",
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 9,
    "channelRange": [
      1,
      2,
      3,
      4,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 157,
    "indoorChannelRange": [
      36,
      40,
      44,
      48
    ],
    "outdoorChannelRange": [
      149,
      153
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,