Back to top

SmartZone 100 Public API Reference Guide

Overview

This reference guide describes the public APIs supported by the SmartZone 100. 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 could use the below all common prefix, where {host} is the IP address of the management interface of the controller.

  • https://{host}:8443/wsg/api/public - Recommend

  • https://{host}:7443/api/public - Deprecated Will be removed in the future version

Version Matrix

SmartZone software has API support for up to 3 major API versions, according to the following matrix.

SZ Version API Version
3.6.2 v4_0 v5_0 v5_1 v6_0 v6_1

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

Time Zone

Africa/AbidjanAfrica/AccraAfrica/Addis_Ababa
Africa/AlgiersAfrica/AsmaraAfrica/Asmera
Africa/BamakoAfrica/BanguiAfrica/Banjul
Africa/BissauAfrica/BlantyreAfrica/Brazzaville
Africa/BujumburaAfrica/CairoAfrica/Casablanca
Africa/CeutaAfrica/ConakryAfrica/Dakar
Africa/Dar_es_SalaamAfrica/DjiboutiAfrica/Douala
Africa/El_AaiunAfrica/FreetownAfrica/Gaborone
Africa/HarareAfrica/JohannesburgAfrica/Juba
Africa/KampalaAfrica/KhartoumAfrica/Kigali
Africa/KinshasaAfrica/LagosAfrica/Libreville
Africa/LomeAfrica/LuandaAfrica/Lubumbashi
Africa/LusakaAfrica/MalaboAfrica/Maputo
Africa/MaseruAfrica/MbabaneAfrica/Mogadishu
Africa/MonroviaAfrica/NairobiAfrica/Ndjamena
Africa/NiameyAfrica/NouakchottAfrica/Ouagadougou
Africa/Porto-NovoAfrica/Sao_TomeAfrica/Timbuktu
Africa/TripoliAfrica/TunisAfrica/Windhoek
America/AdakAmerica/AnchorageAmerica/Anguilla
America/AntiguaAmerica/AraguainaAmerica/Argentina/Buenos_Aires
America/Argentina/CatamarcaAmerica/Argentina/ComodRivadaviaAmerica/Argentina/Cordoba
America/Argentina/JujuyAmerica/Argentina/La_RiojaAmerica/Argentina/Mendoza
America/Argentina/Rio_GallegosAmerica/Argentina/SaltaAmerica/Argentina/San_Juan
America/Argentina/San_LuisAmerica/Argentina/TucumanAmerica/Argentina/Ushuaia
America/ArubaAmerica/AsuncionAmerica/Atikokan
America/AtkaAmerica/BahiaAmerica/Bahia_Banderas
America/BarbadosAmerica/BelemAmerica/Belize
America/Blanc-SablonAmerica/Boa_VistaAmerica/Bogota
America/BoiseAmerica/Buenos_AiresAmerica/Cambridge_Bay
America/Campo_GrandeAmerica/CancunAmerica/Caracas
America/CatamarcaAmerica/CayenneAmerica/Cayman
America/ChicagoAmerica/ChihuahuaAmerica/Coral_Harbour
America/CordobaAmerica/Costa_RicaAmerica/Creston
America/CuiabaAmerica/CuracaoAmerica/Danmarkshavn
America/DawsonAmerica/Dawson_CreekAmerica/Denver
America/DetroitAmerica/DominicaAmerica/Edmonton
America/EirunepeAmerica/El_SalvadorAmerica/Ensenada
America/Fort_NelsonAmerica/Fort_WayneAmerica/Fortaleza
America/Glace_BayAmerica/GodthabAmerica/Goose_Bay
America/Grand_TurkAmerica/GrenadaAmerica/Guadeloupe
America/GuatemalaAmerica/GuayaquilAmerica/Guyana
America/HalifaxAmerica/HavanaAmerica/Hermosillo
America/Indiana/IndianapolisAmerica/Indiana/KnoxAmerica/Indiana/Marengo
America/Indiana/PetersburgAmerica/Indiana/Tell_CityAmerica/Indiana/Vevay
America/Indiana/VincennesAmerica/Indiana/WinamacAmerica/Indianapolis
America/InuvikAmerica/IqaluitAmerica/Jamaica
America/JujuyAmerica/JuneauAmerica/Kentucky/Louisville
America/Kentucky/MonticelloAmerica/Knox_INAmerica/Kralendijk
America/La_PazAmerica/LimaAmerica/Los_Angeles
America/LouisvilleAmerica/Lower_PrincesAmerica/Maceio
America/ManaguaAmerica/ManausAmerica/Marigot
America/MartiniqueAmerica/MatamorosAmerica/Mazatlan
America/MendozaAmerica/MenomineeAmerica/Merida
America/MetlakatlaAmerica/Mexico_CityAmerica/Miquelon
America/MonctonAmerica/MonterreyAmerica/Montevideo
America/MontrealAmerica/MontserratAmerica/Nassau
America/New_YorkAmerica/NipigonAmerica/Nome
America/NoronhaAmerica/North_Dakota/BeulahAmerica/North_Dakota/Center
America/North_Dakota/New_SalemAmerica/OjinagaAmerica/Panama
America/PangnirtungAmerica/ParamariboAmerica/Phoenix
America/Port-au-PrinceAmerica/Port_of_SpainAmerica/Porto_Acre
America/Porto_VelhoAmerica/Puerto_RicoAmerica/Punta_Arenas
America/Rainy_RiverAmerica/Rankin_InletAmerica/Recife
America/ReginaAmerica/ResoluteAmerica/Rio_Branco
America/RosarioAmerica/Santa_IsabelAmerica/Santarem
America/SantiagoAmerica/Santo_DomingoAmerica/Sao_Paulo
America/ScoresbysundAmerica/ShiprockAmerica/Sitka
America/St_BarthelemyAmerica/St_JohnsAmerica/St_Kitts
America/St_LuciaAmerica/St_ThomasAmerica/St_Vincent
America/Swift_CurrentAmerica/TegucigalpaAmerica/Thule
America/Thunder_BayAmerica/TijuanaAmerica/Toronto
America/TortolaAmerica/VancouverAmerica/Virgin
America/WhitehorseAmerica/WinnipegAmerica/Yakutat
America/YellowknifeAntarctica/CaseyAntarctica/Davis
Antarctica/DumontDUrvilleAntarctica/MacquarieAntarctica/Mawson
Antarctica/McMurdoAntarctica/PalmerAntarctica/Rothera
Antarctica/South_PoleAntarctica/SyowaAntarctica/Troll
Antarctica/VostokArctic/LongyearbyenAsia/Aden
Asia/AlmatyAsia/AmmanAsia/Anadyr
Asia/AqtauAsia/AqtobeAsia/Ashgabat
Asia/AshkhabadAsia/AtyrauAsia/Baghdad
Asia/BahrainAsia/BakuAsia/Bangkok
Asia/BarnaulAsia/BeirutAsia/Bishkek
Asia/BruneiAsia/CalcuttaAsia/Chita
Asia/ChoibalsanAsia/ChongqingAsia/Chungking
Asia/ColomboAsia/DaccaAsia/Damascus
Asia/DhakaAsia/DiliAsia/Dubai
Asia/DushanbeAsia/FamagustaAsia/Gaza
Asia/HarbinAsia/HebronAsia/Ho_Chi_Minh
Asia/Hong_KongAsia/HovdAsia/Irkutsk
Asia/IstanbulAsia/JakartaAsia/Jayapura
Asia/JerusalemAsia/KabulAsia/Kamchatka
Asia/KarachiAsia/KashgarAsia/Kathmandu
Asia/KatmanduAsia/KhandygaAsia/Kolkata
Asia/KrasnoyarskAsia/Kuala_LumpurAsia/Kuching
Asia/KuwaitAsia/MacaoAsia/Macau
Asia/MagadanAsia/MakassarAsia/Manila
Asia/MuscatAsia/NicosiaAsia/Novokuznetsk
Asia/NovosibirskAsia/OmskAsia/Oral
Asia/Phnom_PenhAsia/PontianakAsia/Pyongyang
Asia/QatarAsia/QyzylordaAsia/Rangoon
Asia/RiyadhAsia/SaigonAsia/Sakhalin
Asia/SamarkandAsia/SeoulAsia/Shanghai
Asia/SingaporeAsia/SrednekolymskAsia/Taipei
Asia/TashkentAsia/TbilisiAsia/Tehran
Asia/Tel_AvivAsia/ThimbuAsia/Thimphu
Asia/TokyoAsia/TomskAsia/Ujung_Pandang
Asia/UlaanbaatarAsia/Ulan_BatorAsia/Urumqi
Asia/Ust-NeraAsia/VientianeAsia/Vladivostok
Asia/YakutskAsia/YangonAsia/Yekaterinburg
Asia/YerevanAtlantic/AzoresAtlantic/Bermuda
Atlantic/CanaryAtlantic/Cape_VerdeAtlantic/Faeroe
Atlantic/FaroeAtlantic/Jan_MayenAtlantic/Madeira
Atlantic/ReykjavikAtlantic/South_GeorgiaAtlantic/St_Helena
Atlantic/StanleyAustralia/ACTAustralia/Adelaide
Australia/BrisbaneAustralia/Broken_HillAustralia/Canberra
Australia/CurrieAustralia/DarwinAustralia/Eucla
Australia/HobartAustralia/LHIAustralia/Lindeman
Australia/Lord_HoweAustralia/MelbourneAustralia/NSW
Australia/NorthAustralia/PerthAustralia/Queensland
Australia/SouthAustralia/SydneyAustralia/Tasmania
Australia/VictoriaAustralia/WestAustralia/Yancowinna
Brazil/AcreBrazil/DeNoronhaBrazil/East
Brazil/WestCETCST6CDT
Canada/AtlanticCanada/CentralCanada/Eastern
Canada/MountainCanada/NewfoundlandCanada/Pacific
Canada/SaskatchewanCanada/YukonChile/Continental
Chile/EasterIslandCubaEET
EST5EDTEgyptEire
Europe/AmsterdamEurope/AndorraEurope/Astrakhan
Europe/AthensEurope/BelfastEurope/Belgrade
Europe/BerlinEurope/BratislavaEurope/Brussels
Europe/BucharestEurope/BudapestEurope/Busingen
Europe/ChisinauEurope/CopenhagenEurope/Dublin
Europe/GibraltarEurope/GuernseyEurope/Helsinki
Europe/Isle_of_ManEurope/IstanbulEurope/Jersey
Europe/KaliningradEurope/KievEurope/Kirov
Europe/LisbonEurope/LjubljanaEurope/London
Europe/LuxembourgEurope/MadridEurope/Malta
Europe/MariehamnEurope/MinskEurope/Monaco
Europe/MoscowEurope/NicosiaEurope/Oslo
Europe/ParisEurope/PodgoricaEurope/Prague
Europe/RigaEurope/RomeEurope/Samara
Europe/San_MarinoEurope/SarajevoEurope/Saratov
Europe/SimferopolEurope/SkopjeEurope/Sofia
Europe/StockholmEurope/TallinnEurope/Tirane
Europe/TiraspolEurope/UlyanovskEurope/Uzhgorod
Europe/VaduzEurope/VaticanEurope/Vienna
Europe/VilniusEurope/VolgogradEurope/Warsaw
Europe/ZagrebEurope/ZaporozhyeEurope/Zurich
GBGB-EireGMT
GMT0GreenwichHongkong
IcelandIndian/AntananarivoIndian/Chagos
Indian/ChristmasIndian/CocosIndian/Comoro
Indian/KerguelenIndian/MaheIndian/Maldives
Indian/MauritiusIndian/MayotteIndian/Reunion
IranIsraelJamaica
KwajaleinLibyaMET
MST7MDTMexico/BajaNorteMexico/BajaSur
Mexico/GeneralNZNZ-CHAT
NavajoPRCPST8PDT
Pacific/ApiaPacific/AucklandPacific/Bougainville
Pacific/ChathamPacific/ChuukPacific/Easter
Pacific/EfatePacific/EnderburyPacific/Fakaofo
Pacific/FijiPacific/FunafutiPacific/Galapagos
Pacific/GambierPacific/GuadalcanalPacific/Guam
Pacific/HonoluluPacific/JohnstonPacific/Kiritimati
Pacific/KosraePacific/KwajaleinPacific/Majuro
Pacific/MarquesasPacific/MidwayPacific/Nauru
Pacific/NiuePacific/NorfolkPacific/Noumea
Pacific/Pago_PagoPacific/PalauPacific/Pitcairn
Pacific/PohnpeiPacific/PonapePacific/Port_Moresby
Pacific/RarotongaPacific/SaipanPacific/Samoa
Pacific/TahitiPacific/TarawaPacific/Tongatapu
Pacific/TrukPacific/WakePacific/Wallis
Pacific/YapPolandPortugal
ROKTurkeyUCT
US/AlaskaUS/AleutianUS/Arizona
US/CentralUS/East-IndianaUS/Eastern
US/HawaiiUS/Indiana-StarkeUS/Michigan
US/MountainUS/PacificUS/Pacific-New
US/SamoaUTCUniversal
W-SUWETZulu
ESTHSTMST
ACTAETAGT
ARTASTBET
BSTCATCNT
CSTCTTEAT
ECTIETIST
JSTMITNET
NSTPLTPNT
PRTPSTSST
VST

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

    • System
      • Modify CAPTCHA
      • Retrieve CAPTCHA
    • Cluster Management
      • Upload AP Patch File
      • Retrive Uploaded AP Patch File Info
      • Apply AP Patch
      • Retrive AP Patch Cluster Progress Status
      • Retrive AP Patch History
    • GDPR
      • Execute a GDPR report action
    • Account Security
      • Delete the account security profile by id
      • Create the account security profile.
      • Get the account security profile by id
      • Get the account security profiles
      • Modify
      • Modify the account security profile
      • Delete the account security profile
  • What’s Deprecated

  • Changes

    • Ruckus Wireless AP Zone
      • Retrieve
        • attributes added (aaaAffinityEnabled)
      • Create Zone
        • attributes added (aaaAffinityEnabled)
      • Create Zone of IPv6
        • attributes added (aaaAffinityEnabled)
      • Create Zone of Dual
        • attributes added (aaaAffinityEnabled)
      • Modify entire zone
        • attributes added (aaaAffinityEnabled)
      • Modify
        • attributes added (aaaAffinityEnabled)
      • Modify Radio 2.4G
        • attributes added (autoCellSizing)
      • Modify Radio 5G
        • attributes added (autoCellSizing)
    • WLAN
      • Modify Advanced Options
        • attributes added (hdOverheadOptimizeEnable,transientClientMgmtEnable,probeRssiThr,joinIgnoreTimeout,joinAcceptTimeout,joinIgnoreThr)
    • Access Point Configuration
      • Modify Radio 2.4G Override
        • attributes added (autoCellSizing)
      • Modify Radio 5G Override
        • attributes added (autoCellSizing)
    • SCG User
      • Add SCG user
        • attributes added (locked)
      • Get SCG user
        • attributes added (locked)
      • Update SCG user
        • attributes added (locked)
    • SCG User Group
      • Add SCG user group
        • attributes added (accountSecurityProfileId,accountSecurityProfileName)
      • Get SCG user group
        • attributes added (accountSecurityProfileId,accountSecurityProfileName)
    • AP Group
      • Modify Radio 2.4G Override
        • attributes added (autoCellSizing)
      • Modify Radio 5G Override
        • attributes added (autoCellSizing)

Logon Sessions

Logon

POST/v6_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/v6_1/session

Use this API command to log off of the controller.

Response  200

Retrieve

GET/v6_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/v6_1/rkszones

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

URI Parameters
HideShow
index
string (optional) 

The index of the first entry to be retrieved. Default: 0

listSize
string (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/v6_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
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "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" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "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"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "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 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "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
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "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
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "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"
                    }
                }
            }
        },
        "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" : {
            "description" : "IP mode of the zone",
            "enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ]
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the Zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            }
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "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"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "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
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "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"
                }
            }
        },
        "timezone" : {
            "description" : "Time zone",
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "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" : {
                            "description" : "Daylight saving time 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" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time 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" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            },
            "type" : "object"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "description" : "Enterprise-zone.zoneConfiguration.properties.aaaAffinityEnabled.description",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "usbSoftwarePackage" : {
            "description" : "APUsbSoftwarePackage of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "description" : "APUsbSoftwarePackage id or name",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "venueProfile" : {
            "description" : "venue profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio24SuperSet.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio50SuperSet.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "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" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        }
    },
    "type" : "object"
}

Retrieve Mesh Configuration

GET/v6_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/v6_1/rkszones/{id}/mesh

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

Request
HideShow
Body
{
  "ssid": "meshSSID"
}
Schema
{
  "description": "Mesh configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ssid": {
      "description": "SSID of the mesh network",
      "type": "string"
    },
    "passphrase": {
      "description": "Passphrase for the mesh network",
      "type": "string"
    }
  }
}
Response  204

Clear Mesh Configuration

DELETE/v6_1/rkszones/{id}/mesh

Use this API command to disable mesh networking.

Response  204

Create Zone

POST/v6_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
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "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": {
    "recoverySsidEnabled": true,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "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" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "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" : {
                            "description" : "Daylight saving time 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" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time 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" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            },
            "type" : "object"
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio24.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio50.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "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"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "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" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "description" : "Enable proxy AAA Affinity",
            "type" : "boolean"
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "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"
                }
            }
        },
        "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" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "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 ]
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "usbSoftwarePackage" : {
            "description" : "APUsbSoftwarePackage of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "description" : "APUsbSoftwarePackage id or name",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "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
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "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
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "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"
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "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"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "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" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean"
        }
    },
    "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/v6_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
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "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": {
    "recoverySsidEnabled": true,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "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" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "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" : {
                            "description" : "Daylight saving time 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" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time 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" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            },
            "type" : "object"
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio24.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio50.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "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"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "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" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "description" : "Enable proxy AAA Affinity",
            "type" : "boolean"
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "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"
                }
            }
        },
        "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" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "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 ]
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "usbSoftwarePackage" : {
            "description" : "APUsbSoftwarePackage of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "description" : "APUsbSoftwarePackage id or name",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "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
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "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
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "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"
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "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"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "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" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean"
        }
    },
    "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/v6_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
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "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": {
    "recoverySsidEnabled": true,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "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" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "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" : {
                            "description" : "Daylight saving time 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" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time 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" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            },
            "type" : "object"
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio24.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio50.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "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"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "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" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "description" : "Enable proxy AAA Affinity",
            "type" : "boolean"
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "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"
                }
            }
        },
        "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" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "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 ]
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "usbSoftwarePackage" : {
            "description" : "APUsbSoftwarePackage of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "description" : "APUsbSoftwarePackage id or name",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "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
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "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
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "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"
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "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"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "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" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean"
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the zone",
      "type": "string"
    }
  }
}

Modify entire zone

PUT/v6_1/rkszones/{id}

Use this API command to modify entire information of a zone.

Request
HideShow
Body
{
  "domainId": "domainUUIDToMove",
  "name": "zoneModified",
  "description": "description modified",
  "countryCode": "US",
  "timezone": {
    "customizedTimezone": {
      "abbreviation": "ABC",
      "gmtOffset": 4,
      "gmtOffsetMinute": 10
    }
  },
  "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
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "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",
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "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"
  },
  "ipv6TrafficFilterEnabled": 0,
  "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": {
    "recoverySsidEnabled": true,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "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"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "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 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "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
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "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
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "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"
                    }
                }
            }
        },
        "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"
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            }
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "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"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "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
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "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"
                }
            }
        },
        "timezone" : {
            "description" : "Time zone",
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "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" : {
                            "description" : "Daylight saving time 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" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time 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" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            },
            "type" : "object"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "description" : "Enterprise-zone.modifyZone.properties.aaaAffinityEnabled.description",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "usbSoftwarePackage" : {
            "description" : "APUsbSoftwarePackage of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "description" : "APUsbSoftwarePackage id or name",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio24.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio50.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "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" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        }
    },
    "type" : "object"
}
Response  204

Modify

PATCH/v6_1/rkszones/{id}

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

Request
HideShow
Body
{
  "domainId": "domainUUIDToMove",
  "name": "zoneModified",
  "description": "description modified",
  "countryCode": "US",
  "timezone": {
    "customizedTimezone": {
      "abbreviation": "ABC",
      "gmtOffset": 4,
      "gmtOffsetMinute": 10
    }
  },
  "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
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "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",
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "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"
  },
  "ipv6TrafficFilterEnabled": 0,
  "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": {
    "recoverySsidEnabled": true,
    "recoverySsidPskKey": "556612345"
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "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"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "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 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "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
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "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
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "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
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "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"
                    }
                }
            }
        },
        "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"
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                }
            }
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "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"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "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
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "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"
                }
            }
        },
        "timezone" : {
            "description" : "Time zone",
            "additionalProperties" : false,
            "properties" : {
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "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" : {
                            "description" : "Daylight saving time 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" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time 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" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            },
            "type" : "object"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "description" : "Enterprise-zone.modifyZone.properties.aaaAffinityEnabled.description",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "usbSoftwarePackage" : {
            "description" : "APUsbSoftwarePackage of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "usbSoftware" : {
                    "description" : "APUsbSoftwarePackage id or name",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "applyModel" : {
                    "description" : "List of apply models",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio24.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "common.radio50.properties.autoCellSizing.description",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "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"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "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" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        }
    },
    "type" : "object"
}
Response  204

Modify Time Zone

PATCH/v6_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
{
  "description": "Time zone",
  "additionalProperties": false,
  "properties": {
    "customizedTimezone": {
      "description": "User defined time zone",
      "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": {
          "description": "Daylight saving time 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"
          ]
        },
        "end": {
          "description": "Daylight saving time 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"
          ]
        }
      },
      "required": [
        "abbreviation",
        "gmtOffset",
        "gmtOffsetMinute"
      ]
    }
  },
  "type": "object"
}
Response  204

Modify AP Logon

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

Modify Radio 2.4G

PATCH/v6_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
{
  "description": "AP 2.4GHz radio configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "autoCellSizing": {
      "description": "common.radio24.properties.autoCellSizing.description",
      "type": "boolean"
    },
    "txPower": {
      "description": "Transmission power",
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ]
    },
    "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"
      }
    }
  }
}
Response  204

Modify Radio 5G

PATCH/v6_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
{
  "description": "AP 5GHz radio configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "autoCellSizing": {
      "description": "common.radio50.properties.autoCellSizing.description",
      "type": "boolean"
    },
    "txPower": {
      "description": "Transmission power",
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ]
    },
    "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"
      }
    }
  }
}
Response  204

Modify Syslog

PATCH/v6_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
{
  "description": "Syslog configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "address": {
      "description": "Address of the syslog server.",
      "type": "string"
    },
    "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"
    }
  }
}
Response  204

Disable Syslog

DELETE/v6_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/v6_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
{
  "description": "Smart monitor configuration of the zone.",
  "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
    }
  }
}
Response  204

Disable Smart Monitor

DELETE/v6_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/v6_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
{
  "description": "AP client admission control 2.4GHz radio configuration of the zone.",
  "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
    }
  }
}
Response  204

Disable Client Admission Control 2.4G

DELETE/v6_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/v6_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
{
  "description": "AP client admission control 5GHz radio configuration of the zone.",
  "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
    }
  }
}
Response  204

Disable Client Admission Control 5G

DELETE/v6_1/rkszones/{id}/clientAdmissionControl50

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

Response  204

Modify tunnel profile

PATCH/v6_1/rkszones/{id}/tunnelProfile

Use this API command to change tunnel profile of Zone.

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

Modify Background Scanning 2.4G

PATCH/v6_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
{
  "description": "Background scanning on 2.4GHz radio configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "frequencyInSec": {
      "description": "Frequency in second",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    }
  }
}
Response  204

Disable Background Scanning 2.4G

DELETE/v6_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/v6_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
{
  "description": "Background scanning on 5GHz radio configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "frequencyInSec": {
      "description": "Frequency in second",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    }
  }
}
Response  204

Disable Background Scanning 5G

DELETE/v6_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/v6_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
{
  "description": "Client load balancing on 2.4GHz radio configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "adjacentRadioThreshold": {
      "description": "Adjacent radio threshold",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}
Response  204

Disable Client Load Balancing 2.4G

DELETE/v6_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/v6_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
{
  "description": "Client load balancing on 5GHz radio configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "adjacentRadioThreshold": {
      "description": "Adjacent radio threshold",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}
Response  204

Disable Client Load Balancing 5G

DELETE/v6_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/v6_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
{
  "description": "Band balancing configuration of the zone.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mode": {
      "description": "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
      "enum": [
        "BASIC",
        "PROACTIVE",
        "STRICT"
      ]
    },
    "wifi24Percentage": {
      "description": "Percentage of client load on 2.4GHz radio band",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    }
  }
}
Response  204

Disable Band Balancing

DELETE/v6_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/v6_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
{
  "description": "AP reboot timeout of the zone.",
  "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
      ]
    }
  }
}
Response  204

Modify Node Affinity Profile

PATCH/v6_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
{
  "description": "Node affinity profile of the zone.",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Hotspot2.0 Venue Profile

PATCH/v6_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
{
  "description": "Venue profile configuration of the zone.",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Clear Hotspot2.0 Venue Profile

DELETE/v6_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/v6_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
{
  "description": "Rogue AP detection configuration of the zone.",
  "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"
    }
  }
}
Response  204

Disable Rogue

DELETE/v6_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/v6_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
{
  "description": "Location based service configuration of the zone.",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Disable Location Based Service

DELETE/v6_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/v6_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,
  "