SmartCell Gateway 200 Public API Reference Guide
Overview
This reference guide describes the public APIs supported by the SmartCell Gateway (SCG) 200. 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.
SCG Version | API Version |
---|---|
3.6.1 |
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/Abidjan | Africa/Accra | Africa/Addis_Ababa |
Africa/Algiers | Africa/Asmara | Africa/Asmera |
Africa/Bamako | Africa/Bangui | Africa/Banjul |
Africa/Bissau | Africa/Blantyre | Africa/Brazzaville |
Africa/Bujumbura | Africa/Cairo | Africa/Casablanca |
Africa/Ceuta | Africa/Conakry | Africa/Dakar |
Africa/Dar_es_Salaam | Africa/Djibouti | Africa/Douala |
Africa/El_Aaiun | Africa/Freetown | Africa/Gaborone |
Africa/Harare | Africa/Johannesburg | Africa/Juba |
Africa/Kampala | Africa/Khartoum | Africa/Kigali |
Africa/Kinshasa | Africa/Lagos | Africa/Libreville |
Africa/Lome | Africa/Luanda | Africa/Lubumbashi |
Africa/Lusaka | Africa/Malabo | Africa/Maputo |
Africa/Maseru | Africa/Mbabane | Africa/Mogadishu |
Africa/Monrovia | Africa/Nairobi | Africa/Ndjamena |
Africa/Niamey | Africa/Nouakchott | Africa/Ouagadougou |
Africa/Porto-Novo | Africa/Sao_Tome | Africa/Timbuktu |
Africa/Tripoli | Africa/Tunis | Africa/Windhoek |
America/Adak | America/Anchorage | America/Anguilla |
America/Antigua | America/Araguaina | America/Argentina/Buenos_Aires |
America/Argentina/Catamarca | America/Argentina/ComodRivadavia | America/Argentina/Cordoba |
America/Argentina/Jujuy | America/Argentina/La_Rioja | America/Argentina/Mendoza |
America/Argentina/Rio_Gallegos | America/Argentina/Salta | America/Argentina/San_Juan |
America/Argentina/San_Luis | America/Argentina/Tucuman | America/Argentina/Ushuaia |
America/Aruba | America/Asuncion | America/Atikokan |
America/Atka | America/Bahia | America/Bahia_Banderas |
America/Barbados | America/Belem | America/Belize |
America/Blanc-Sablon | America/Boa_Vista | America/Bogota |
America/Boise | America/Buenos_Aires | America/Cambridge_Bay |
America/Campo_Grande | America/Cancun | America/Caracas |
America/Catamarca | America/Cayenne | America/Cayman |
America/Chicago | America/Chihuahua | America/Coral_Harbour |
America/Cordoba | America/Costa_Rica | America/Creston |
America/Cuiaba | America/Curacao | America/Danmarkshavn |
America/Dawson | America/Dawson_Creek | America/Denver |
America/Detroit | America/Dominica | America/Edmonton |
America/Eirunepe | America/El_Salvador | America/Ensenada |
America/Fort_Nelson | America/Fort_Wayne | America/Fortaleza |
America/Glace_Bay | America/Godthab | America/Goose_Bay |
America/Grand_Turk | America/Grenada | America/Guadeloupe |
America/Guatemala | America/Guayaquil | America/Guyana |
America/Halifax | America/Havana | America/Hermosillo |
America/Indiana/Indianapolis | America/Indiana/Knox | America/Indiana/Marengo |
America/Indiana/Petersburg | America/Indiana/Tell_City | America/Indiana/Vevay |
America/Indiana/Vincennes | America/Indiana/Winamac | America/Indianapolis |
America/Inuvik | America/Iqaluit | America/Jamaica |
America/Jujuy | America/Juneau | America/Kentucky/Louisville |
America/Kentucky/Monticello | America/Knox_IN | America/Kralendijk |
America/La_Paz | America/Lima | America/Los_Angeles |
America/Louisville | America/Lower_Princes | America/Maceio |
America/Managua | America/Manaus | America/Marigot |
America/Martinique | America/Matamoros | America/Mazatlan |
America/Mendoza | America/Menominee | America/Merida |
America/Metlakatla | America/Mexico_City | America/Miquelon |
America/Moncton | America/Monterrey | America/Montevideo |
America/Montreal | America/Montserrat | America/Nassau |
America/New_York | America/Nipigon | America/Nome |
America/Noronha | America/North_Dakota/Beulah | America/North_Dakota/Center |
America/North_Dakota/New_Salem | America/Ojinaga | America/Panama |
America/Pangnirtung | America/Paramaribo | America/Phoenix |
America/Port-au-Prince | America/Port_of_Spain | America/Porto_Acre |
America/Porto_Velho | America/Puerto_Rico | America/Punta_Arenas |
America/Rainy_River | America/Rankin_Inlet | America/Recife |
America/Regina | America/Resolute | America/Rio_Branco |
America/Rosario | America/Santa_Isabel | America/Santarem |
America/Santiago | America/Santo_Domingo | America/Sao_Paulo |
America/Scoresbysund | America/Shiprock | America/Sitka |
America/St_Barthelemy | America/St_Johns | America/St_Kitts |
America/St_Lucia | America/St_Thomas | America/St_Vincent |
America/Swift_Current | America/Tegucigalpa | America/Thule |
America/Thunder_Bay | America/Tijuana | America/Toronto |
America/Tortola | America/Vancouver | America/Virgin |
America/Whitehorse | America/Winnipeg | America/Yakutat |
America/Yellowknife | Antarctica/Casey | Antarctica/Davis |
Antarctica/DumontDUrville | Antarctica/Macquarie | Antarctica/Mawson |
Antarctica/McMurdo | Antarctica/Palmer | Antarctica/Rothera |
Antarctica/South_Pole | Antarctica/Syowa | Antarctica/Troll |
Antarctica/Vostok | Arctic/Longyearbyen | Asia/Aden |
Asia/Almaty | Asia/Amman | Asia/Anadyr |
Asia/Aqtau | Asia/Aqtobe | Asia/Ashgabat |
Asia/Ashkhabad | Asia/Atyrau | Asia/Baghdad |
Asia/Bahrain | Asia/Baku | Asia/Bangkok |
Asia/Barnaul | Asia/Beirut | Asia/Bishkek |
Asia/Brunei | Asia/Calcutta | Asia/Chita |
Asia/Choibalsan | Asia/Chongqing | Asia/Chungking |
Asia/Colombo | Asia/Dacca | Asia/Damascus |
Asia/Dhaka | Asia/Dili | Asia/Dubai |
Asia/Dushanbe | Asia/Famagusta | Asia/Gaza |
Asia/Harbin | Asia/Hebron | Asia/Ho_Chi_Minh |
Asia/Hong_Kong | Asia/Hovd | Asia/Irkutsk |
Asia/Istanbul | Asia/Jakarta | Asia/Jayapura |
Asia/Jerusalem | Asia/Kabul | Asia/Kamchatka |
Asia/Karachi | Asia/Kashgar | Asia/Kathmandu |
Asia/Katmandu | Asia/Khandyga | Asia/Kolkata |
Asia/Krasnoyarsk | Asia/Kuala_Lumpur | Asia/Kuching |
Asia/Kuwait | Asia/Macao | Asia/Macau |
Asia/Magadan | Asia/Makassar | Asia/Manila |
Asia/Muscat | Asia/Nicosia | Asia/Novokuznetsk |
Asia/Novosibirsk | Asia/Omsk | Asia/Oral |
Asia/Phnom_Penh | Asia/Pontianak | Asia/Pyongyang |
Asia/Qatar | Asia/Qyzylorda | Asia/Rangoon |
Asia/Riyadh | Asia/Saigon | Asia/Sakhalin |
Asia/Samarkand | Asia/Seoul | Asia/Shanghai |
Asia/Singapore | Asia/Srednekolymsk | Asia/Taipei |
Asia/Tashkent | Asia/Tbilisi | Asia/Tehran |
Asia/Tel_Aviv | Asia/Thimbu | Asia/Thimphu |
Asia/Tokyo | Asia/Tomsk | Asia/Ujung_Pandang |
Asia/Ulaanbaatar | Asia/Ulan_Bator | Asia/Urumqi |
Asia/Ust-Nera | Asia/Vientiane | Asia/Vladivostok |
Asia/Yakutsk | Asia/Yangon | Asia/Yekaterinburg |
Asia/Yerevan | Atlantic/Azores | Atlantic/Bermuda |
Atlantic/Canary | Atlantic/Cape_Verde | Atlantic/Faeroe |
Atlantic/Faroe | Atlantic/Jan_Mayen | Atlantic/Madeira |
Atlantic/Reykjavik | Atlantic/South_Georgia | Atlantic/St_Helena |
Atlantic/Stanley | Australia/ACT | Australia/Adelaide |
Australia/Brisbane | Australia/Broken_Hill | Australia/Canberra |
Australia/Currie | Australia/Darwin | Australia/Eucla |
Australia/Hobart | Australia/LHI | Australia/Lindeman |
Australia/Lord_Howe | Australia/Melbourne | Australia/NSW |
Australia/North | Australia/Perth | Australia/Queensland |
Australia/South | Australia/Sydney | Australia/Tasmania |
Australia/Victoria | Australia/West | Australia/Yancowinna |
Brazil/Acre | Brazil/DeNoronha | Brazil/East |
Brazil/West | CET | CST6CDT |
Canada/Atlantic | Canada/Central | Canada/East-Saskatchewan |
Canada/Eastern | Canada/Mountain | Canada/Newfoundland |
Canada/Pacific | Canada/Saskatchewan | Canada/Yukon |
Chile/Continental | Chile/EasterIsland | Cuba |
EET | EST5EDT | Egypt |
Eire | Europe/Amsterdam | Europe/Andorra |
Europe/Astrakhan | Europe/Athens | Europe/Belfast |
Europe/Belgrade | Europe/Berlin | Europe/Bratislava |
Europe/Brussels | Europe/Bucharest | Europe/Budapest |
Europe/Busingen | Europe/Chisinau | Europe/Copenhagen |
Europe/Dublin | Europe/Gibraltar | Europe/Guernsey |
Europe/Helsinki | Europe/Isle_of_Man | Europe/Istanbul |
Europe/Jersey | Europe/Kaliningrad | Europe/Kiev |
Europe/Kirov | Europe/Lisbon | Europe/Ljubljana |
Europe/London | Europe/Luxembourg | Europe/Madrid |
Europe/Malta | Europe/Mariehamn | Europe/Minsk |
Europe/Monaco | Europe/Moscow | Europe/Nicosia |
Europe/Oslo | Europe/Paris | Europe/Podgorica |
Europe/Prague | Europe/Riga | Europe/Rome |
Europe/Samara | Europe/San_Marino | Europe/Sarajevo |
Europe/Saratov | Europe/Simferopol | Europe/Skopje |
Europe/Sofia | Europe/Stockholm | Europe/Tallinn |
Europe/Tirane | Europe/Tiraspol | Europe/Ulyanovsk |
Europe/Uzhgorod | Europe/Vaduz | Europe/Vatican |
Europe/Vienna | Europe/Vilnius | Europe/Volgograd |
Europe/Warsaw | Europe/Zagreb | Europe/Zaporozhye |
Europe/Zurich | GB | GB-Eire |
GMT | GMT0 | Greenwich |
Hongkong | Iceland | Indian/Antananarivo |
Indian/Chagos | Indian/Christmas | Indian/Cocos |
Indian/Comoro | Indian/Kerguelen | Indian/Mahe |
Indian/Maldives | Indian/Mauritius | Indian/Mayotte |
Indian/Reunion | Iran | Israel |
Jamaica | Kwajalein | Libya |
MET | MST7MDT | Mexico/BajaNorte |
Mexico/BajaSur | Mexico/General | NZ |
NZ-CHAT | Navajo | PRC |
PST8PDT | Pacific/Apia | Pacific/Auckland |
Pacific/Bougainville | Pacific/Chatham | Pacific/Chuuk |
Pacific/Easter | Pacific/Efate | Pacific/Enderbury |
Pacific/Fakaofo | Pacific/Fiji | Pacific/Funafuti |
Pacific/Galapagos | Pacific/Gambier | Pacific/Guadalcanal |
Pacific/Guam | Pacific/Honolulu | Pacific/Johnston |
Pacific/Kiritimati | Pacific/Kosrae | Pacific/Kwajalein |
Pacific/Majuro | Pacific/Marquesas | Pacific/Midway |
Pacific/Nauru | Pacific/Niue | Pacific/Norfolk |
Pacific/Noumea | Pacific/Pago_Pago | Pacific/Palau |
Pacific/Pitcairn | Pacific/Pohnpei | Pacific/Ponape |
Pacific/Port_Moresby | Pacific/Rarotonga | Pacific/Saipan |
Pacific/Samoa | Pacific/Tahiti | Pacific/Tarawa |
Pacific/Tongatapu | Pacific/Truk | Pacific/Wake |
Pacific/Wallis | Pacific/Yap | Poland |
Portugal | ROK | Turkey |
UCT | US/Alaska | US/Aleutian |
US/Arizona | US/Central | US/East-Indiana |
US/Eastern | US/Hawaii | US/Indiana-Starke |
US/Michigan | US/Mountain | US/Pacific |
US/Pacific-New | US/Samoa | UTC |
Universal | W-SU | WET |
Zulu | EST | HST |
MST | ACT | AET |
AGT | ART | AST |
BET | BST | CAT |
CNT | CST | CTT |
EAT | ECT | IET |
IST | JST | MIT |
NET | NST | PLT |
PNT | PRT | PST |
SST | 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
- 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
- System
-
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)
- Retrieve
- WLAN
- Modify Advanced Options
- attributes added (hdOverheadOptimizeEnable,transientClientMgmtEnable,probeRssiThr,joinIgnoreTimeout,joinAcceptTimeout,joinIgnoreThr)
- Modify Advanced Options
- Access Point Configuration
- Modify Radio 2.4G Override
- attributes added (autoCellSizing)
- Modify Radio 5G Override
- attributes added (autoCellSizing)
- Modify Radio 2.4G Override
- SCG User
- Add SCG user
- attributes added (locked)
- Get SCG user
- attributes added (locked)
- Update SCG user
- attributes added (locked)
- Add SCG user
- SCG User Group
- Add SCG user group
- attributes added (accountSecurityProfileId,accountSecurityProfileName)
- Get SCG user group
- attributes added (accountSecurityProfileId,accountSecurityProfileName)
- Add SCG user group
- AP Group
- Modify Radio 2.4G Override
- attributes added (autoCellSizing)
- Modify Radio 5G Override
- attributes added (autoCellSizing)
- Modify Radio 2.4G Override
- Ruckus Wireless AP Zone
Logon Sessions ¶
Logon ¶
POST/v6_1/session
Use this API command to log on to the controller and acquire a valid logon session.
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"
]
}
200
Body
{
"controllerVersion": "1"
}
Schema
{
"type": "object",
"properties": {
"controllerVersion": {
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/session
Use this API command to retrieve information about the current logon session.
200
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.
- 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
200
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.
200
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": "No_Tunneled",
"tunnelProfile": null,
"backgroundScanning24": null,
"backgroundScanning50": null,
"clientLoadBalancing24": null,
"clientLoadBalancing50": null,
"bandBalancing": null,
"rogue": null,
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"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"
},
"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": true
}
],
"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
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the zone",
"type" : "string"
},
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"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"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"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" ]
}
}
},
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"ipMode" : {
"description" : "IP mode of the zone",
"enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ]
},
"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.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"
},
"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" : "zone.zoneConfiguration.properties.aaaAffinityEnabled.description",
"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"
}
}
}
Retrieve Mesh Configuration ¶
GET/v6_1/rkszones/{id}/mesh
Use this API command to retrieve the mesh configuration of a zone.
200
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.
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"
}
}
}
204
Clear Mesh Configuration ¶
Create Zone ¶
POST/v6_1/rkszones
Use this API command to create a new Ruckus Wireless AP zone.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "createZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"customizedTimezone": {
"abbreviation": "TPE",
"gmtOffset": 0,
"gmtOffsetMinute": 0
}
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"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": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"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
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"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": false,
"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": {
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"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" ]
}
}
},
"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" ]
}
201
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.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "createZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"customizedTimezone": {
"abbreviation": "TPE",
"gmtOffset": 0,
"gmtOffsetMinute": 0
}
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"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": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"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
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"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": false,
"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": {
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"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" ]
}
}
},
"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" ]
}
201
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.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "createZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"customizedTimezone": {
"abbreviation": "TPE",
"gmtOffset": 0,
"gmtOffsetMinute": 0
}
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"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": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"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
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"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": false,
"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": {
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"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" ]
}
}
},
"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" ]
}
201
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.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"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": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"channelModeEnabled": false,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"aaaAffinityEnabled": false,
"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,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"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": false,
"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": {
"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
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"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" ]
}
}
},
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"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"
}
}
}
204
Modify ¶
PATCH/v6_1/rkszones/{id}
Use this API command to modify the basic information of a zone.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"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": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"channelModeEnabled": false,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"aaaAffinityEnabled": false,
"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,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"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": false,
"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": {
"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
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"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" ]
}
}
},
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"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"
}
}
}
204
Modify Time Zone ¶
PATCH/v6_1/rkszones/{id}/timezone
Use this API command to modify the time zone of a zone.
Body
‧ Sample : systemTimezone sample1
{
"systemTimezone" : "America/Whitehorse"
}
‧ Sample : systemTimezone sample2
{
"systemTimezone" : "PRC"
}
‧ Sample : customizedTimezone sample
{
"customizedTimezone" : {
"abbreviation" : "ABC",
"gmtOffset" : 4,
"gmtOffsetMinute" : 10
}
}
Schema
{
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"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" ]
}
}
}
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.
Body
{
"apLoginName": "admin",
"apLoginPassword": "admin!234"
}
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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
}
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.
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"
}
}
}
}
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.
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"
}
}
}
}
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.
Body
{
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"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"
}
}
}
204
Disable Syslog ¶
DELETE/v6_1/rkszones/{id}/syslog
Use this API command to disable syslog configuration for APs that belong to a zone.
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.
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
}
}
}
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.
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.
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
}
}
}
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.
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.
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
}
}
}
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.
204
Modify tunnel profile ¶
PATCH/v6_1/rkszones/{id}/tunnelProfile
Use this API command to change tunnel profile of Zone.
Body
{
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
}
Schema
{
"description": "Tunnel type configuration of the zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
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.
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
}
}
}
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.
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.
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
}
}
}
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.
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.
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
}
}
}
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.
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.
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
}
}
}
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.
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.
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
}
}
}
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.
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.
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
]
}
}
}
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.
Schema
{
"description": "Node affinity profile of the zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
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.
Schema
{
"description": "Venue profile configuration of the zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
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.
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.
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"
}
}
}
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.
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.
Schema
{
"description": "Location based service configuration of the zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
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.
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.
200
Body
{
"ledStatusEnabled": true,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 30,
"holdTimeInSec": 120,
"managementIPTLVEnabled": false
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": false,
"ethPortProfile": null
},
{
"portName": "LAN2",
"enabled": true,
"ethPortProfile": {
"id": "0",
"name": "Default Trunk Port"
}
},
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1",
"name": "Default Access Port"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"ledMode": {
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"enum": [
null,
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus"
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default": 2,
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}
Modify AP Model ¶
PUT/v6_1/rkszones/{zoneId}/apmodel/{model}
Use this API command to modify the AP model specific configuration that belong to a zone.
Body
{
"ledStatusEnabled": true,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 30,
"holdTimeInSec": 120,
"managementIPTLVEnabled": false
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": false,
"ethPortProfile": null
},
{
"portName": "LAN2",
"enabled": true,
"ethPortProfile": {
"id": "0",
"name": "Default Trunk Port"
}
},
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1",
"name": "Default Access Port"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"ledMode": {
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"enum": [
null,
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus"
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default": 2,
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}
204
Retrieve AP Model Common Attribute ¶
GET/v6_1/rkszones/{zoneId}/apmodel/{model}/commonAttribute
Use this API command to retrieve AP model common attribute that belong to a zone.
200
Body
{
"nonEditablePorts": [
2
],
"isAllowDisableExtAnt": null,
"nonVisiblePorts": [
2
],
"hasScanRadio": null,
"hasCablemodem": true,
"hasGps": false,
"isDualRadio": true,
"isOutdoor": false,
"maxChannelization24G": 40,
"maxChannelization5G": 80,
"maxClientsUpper": 256,
"maxWlanNum24G": 15,
"maxWlanNum5G": 16,
"noAvc": false,
"noMesh": false,
"reserved5GWlanForMesh": 3,
"support11AC": true,
"supportChannelization160": null,
"supportAPUsbSoftwarePackage": null,
"supportBandSwitch": false,
"supportBonjour": true,
"supportIpsec": false,
"supportLBS": true,
"supportResetCablemodem": true,
"allowDfsCountry": "US",
"ram": 512,
"numOfCores": 4,
"cpuFrequency": 600,
"scalingFactor": 1,
"capabilityScore": 75
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"nonEditablePorts": {
"type": "array",
"items": {
"type": "integer"
}
},
"isAllowDisableExtAnt": {
"type": [
"boolean",
"null"
]
},
"nonVisiblePorts": {
"type": "array",
"items": {
"type": "integer"
}
},
"hasScanRadio": {
"type": [
"boolean",
"null"
]
},
"hasCablemodem": {
"type": [
"boolean",
"null"
]
},
"hasGps": {
"type": [
"boolean",
"null"
]
},
"isDualRadio": {
"type": [
"boolean",
"null"
]
},
"isOutdoor": {
"type": [
"boolean",
"null"
]
},
"maxChannelization24G": {
"type": "integer"
},
"maxChannelization5G": {
"type": "integer"
},
"maxClientsUpper": {
"type": "integer"
},
"maxWlanNum24G": {
"type": "integer"
},
"maxWlanNum5G": {
"type": "integer"
},
"noAvc": {
"type": [
"boolean",
"null"
]
},
"noMesh": {
"type": [
"boolean",
"null"
]
},
"reserved5GWlanForMesh": {
"type": "integer"
},
"support11AC": {
"type": [
"boolean",
"null"
]
},
"supportChannelization160": {
"type": [
"boolean",
"null"
]
},
"supportAPUsbSoftwarePackage": {
"type": [
"boolean",
"null"
]
},
"supportBandSwitch": {
"type": [
"boolean",
"null"
]
},
"supportBonjour": {
"type": [
"boolean",
"null"
]
},
"supportIpsec": {
"type": [
"boolean",
"null"
]
},
"supportLBS": {
"type": [
"boolean",
"null"
]
},
"supportResetCablemodem": {
"type": [
"boolean",
"null"
]
},
"allowDfsCountry": {
"type": "string"
},
"ram": {
"type": "integer"
},
"numOfCores": {
"type": "integer"
},
"cpuFrequency": {
"type": "integer"
},
"scalingFactor": {
"type": "integer"
},
"capabilityScore": {
"type": "number"
}
}
}
Modify Radio 2.4G Auto ChannelSelectMode ¶
PATCH/v6_1/rkszones/{id}/autoChannelSelection24
Modify Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of a zone.
Body
{
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
}
Schema
{
"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
}
}
}
204
Modify Radio 5G Auto ChannelSelectMode ¶
PATCH/v6_1/rkszones/{id}/autoChannelSelection50
Modify Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of a zone.
Body
{
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
}
Schema
{
"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
}
}
}
204
Modify IPsec Profile ¶
PATCH/v6_1/rkszones/{id}/ipsecProfile
Modify IPsec Profile of a zone.
Body
{
"id": "ipsecProfileId",
"name": "ipsecProfileName"
}
Schema
{
"description": "ipsec profile configuration of the Zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Modify AP Usb Software Package ¶
PATCH/v6_1/rkszones/{id}/usbSoftwarePackage
Modify AP Usb Software Package of a zone.
Schema
{
"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"
}
}
}
}
204
Modify AP Management Vlan ¶
PATCH/v6_1/rkszones/{id}/apMgmtVlan
Modify AP Management Vlan of a zone.
Body
{
"id": 1,
"mode": "KEEP"
}
Schema
{
"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"
}
}
}
204
Disable AP Usb Software Package ¶
DELETE/v6_1/rkszones/{id}/usbSoftwarePackage
Disable AP Usb Software Package of a zone.
- applyModel
string
(optional)Specify ap models. ex : applyModel=ZF7321U&applyModel=ZF7323
204
Modify Altitude ¶
PATCH/v6_1/rkszones/{id}/altitude
Use this API command to modify the altitude configuration of zone.
Body
{
"altitudeUnit": "meters",
"altitudeValue": 1
}
Schema
{
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"enum": [
"meters",
"floor"
]
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
}
204
Disable Altitude ¶
DELETE/v6_1/rkszones/{id}/altitude
Use this API command to disable altitude configuration of zone.
204
Retrieve AP Firmware List ¶
GET/v6_1/rkszones/{zoneId}/apFirmware
Use this API command to retrieve AP Firmware the list that belong to a zone.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"firmwareVersion": "3.4.0.101.492",
"unsupportedApModelSummary": [
{
"model": "R300",
"amount": 1
}
],
"supported": false
},
{
"firmwareVersion": "3.4.0.101.505",
"unsupportedApModelSummary": [],
"supported": true
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"firmwareVersion": {
"description": "version of the AP firmare",
"type": "string"
},
"unsupportedApModelSummary": {
"description": "summary of the AP Model is unsupported for AP firmware version.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"model": {
"description": "name of the AP Model",
"type": "string"
},
"amount": {
"description": "amount of the AP Model",
"type": "integer"
}
}
}
},
"supported": {
"description": "version of the AP firmare is supported for Upgrade or Downgrade.",
"type": "boolean"
}
}
}
}
}
}
Change AP Firmware ¶
PUT/v6_1/rkszones/{zoneId}/apFirmware
Use this API command to change the AP Firmware that belong to a zone.
Body
{
"firmwareVersion": "3.4.0.101.25"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"firmwareVersion": {
"description": "new version of the AP firmare",
"type": "string"
}
}
}
204
Modify AP SNMP Options ¶
PATCH/v6_1/rkszones/{id}/snmpAgent
Use this API command to modify SNMPv2 and SNMPv3 agent that belong to a zone.
Body
{
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
}
Schema
{
"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"
]
}
}
}
}
204
Clear AP SNMP Options ¶
DELETE/v6_1/rkszones/{id}/snmpAgent
Use this API command to clear SNMPv2 and SNMPv3 agent that belong to a zone.
204
Modify zone recovery SSID ¶
PATCH/v6_1/rkszones/{id}/recoverySsid
Modify recovery ssid setting of a zone (setup a password, or enable/disable).
Body
{
"recoverySsidPskKey": "556612345"
}
Schema
{
"description": "Recovery SSID",
"type": "object",
"additionalProperties": false,
"properties": {
"recoverySsidPskKey": {
"description": "recovery ssid password",
"type": "string"
},
"recoverySsidEnabled": {
"description": "recovery ssid enable/disable",
"type": "boolean"
}
}
}
204
Disable zone recovery SSID ¶
DELETE/v6_1/rkszones/{id}/recoverySsid
Disable recovery ssid setting of a zone (setup a password, or enable/disable).
204
Modify DHCP/NAT service configuration ¶
PATCH/v6_1/rkszones/{id}/dhcpSiteConfig
Use this API command to modify DHCP/NAT service configuration of Zone.
Body
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs
{
"siteEnabled" : true,
"siteMode" : "EnableOnEachAPs",
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs
{
"siteEnabled" : true,
"manualSelect" : true,
"siteMode" : "EnableOnMultipleAPs",
"siteAps" : [ {
"apMac" : "38:FF:36:00:0E:10",
"apServerEnabled" : true,
"apServerPrimary" : true
}, {
"apMac" : "58:FF:36:00:0E:20",
"apServerEnabled" : true,
"apServerPrimary" : false
} ],
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
Schema
{
"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"
}
}
}
}
204
Retrieve DHCP/NAT service IP assignment ¶
POST/v6_1/rkszones/{zoneId}/dhcpSite/dhcpSiteConfig/doAssignIp
Use this API command to get the DHCP/NAT service IP assignment when selecting with “Enable on Multiple APs”. In the Manually Select AP mode (the manualSelect is true), the body should contain the selected APs (include the siteAps array). Otherwise, there is no need to include the selected APs in the Auto Select AP mode (see samples).
Body
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Manually Select AP
{
"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" : true
} ],
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Auto Select AP
{
"siteEnabled" : true,
"manualSelect" : false,
"siteMode" : "EnableOnMultipleAPs",
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
Schema
{
"description" : "DHCP Service Assign IP For Server and Gateway",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs" ]
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
200
Body
{
"zoneName": "zoneK",
"siteEnabled": true,
"manualSelect": true,
"siteMode": "EnableOnMultipleAPs",
"siteAps": [
{
"apMac": "38:FF:36:00:0E:20",
"apServerEnabled": true,
"apGatewayEnabled": true
},
{
"apMac": "58:FF:36:00:0E:20",
"apServerEnabled": true,
"apGatewayEnabled": true
}
],
"siteProfiles": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
}
Schema
{
"description": "DHCP Site Configuration in Zone",
"type": "object",
"additionalProperties": false,
"properties": {
"zoneName": {
"description": "DHCP Service Zone Name",
"type": "string"
},
"siteEnabled": {
"description": "DHCP Service Enabling Status",
"type": "boolean"
},
"manualSelect": {
"description": "DHCP Service AP Selection Mode",
"type": "boolean"
},
"siteMode": {
"description": "DHCP Service mode",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs"
]
},
"siteAps": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Site selected APs",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"apStatus": {
"enum": [
"Online",
"Offline",
"Flagged"
]
},
"apServerEnabled": {
"type": "boolean"
},
"apServerPrimary": {
"type": "boolean"
},
"apServerIp": {
"type": "string"
},
"apGatewayIp": {
"type": "string"
}
}
}
},
"siteProfiles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 2,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
}
}
}
Retrieve DHCP/NAT service configuration within Domain ¶
POST/v6_1/rkszones/services/dhcpSiteConfig/query
Use this API command to modify DHCP/NAT service configuration of Domain. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"zoneName": "Default Zone",
"siteEnabled": false,
"manualSelect": false,
"siteMode": "EnableOnEachAPs",
"siteProfiles": [],
"siteAps": []
},
{
"zoneName": "zoneK",
"siteEnabled": true,
"manualSelect": false,
"siteMode": "EnableOnEachAPs",
"siteProfiles": [
{
"id": "c1b60951-eeb6-11e6-850a-525400f698b4",
"zoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
"name": "P01",
"description": "",
"vlanId": 10,
"subnetNetworkIp": "192.168.10.0",
"subnetMask": "255.255.255.0",
"poolStartIp": "192.168.10.1",
"poolEndIp": "192.168.10.100",
"primaryDnsIp": "",
"secondaryDnsIp": "",
"leaseTimeHours": 0,
"leaseTimeMinutes": 5
}
],
"siteAps": [
{
"apMac": "EC:8C:A2:01:C5:B0",
"apServerEnabled": true,
"apServerPrimary": true,
"apServerIp": "192.168.10.1",
"apGatewayIp": "192.168.10.1",
"apName": "RuckusAP",
"apStatus": "Offline"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneName": {
"description": "DHCP Service Zone Name",
"type": "string"
},
"siteEnabled": {
"description": "DHCP Service Enabling Status",
"type": "boolean"
},
"manualSelect": {
"description": "DHCP Service AP Selection Mode",
"type": "boolean"
},
"siteMode": {
"description": "DHCP Service mode",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs"
]
},
"siteAps": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Site selected APs",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"apStatus": {
"enum": [
"Online",
"Offline",
"Flagged"
]
},
"apServerEnabled": {
"type": "boolean"
},
"apServerPrimary": {
"type": "boolean"
},
"apServerIp": {
"type": "string"
},
"apGatewayIp": {
"type": "string"
}
}
}
},
"siteProfiles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 2,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
}
}
}
}
}
}
Modify Bonjour Fencing Policy configuration ¶
PATCH/v6_1/rkszones/{id}/bonjourFencingPolicy
Use this API command to modify Bonjour Fencing Policy configuration of Zone.
Schema
{
"description": "Bonjour Fencing Policy on the AP",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
AP Group ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/apgroups
Use this API command to retrieve the list of AP groups that belong to a zone.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "apGroupUUID",
"name": "apGroupName"
},
{
"id": "apGroupUUID2",
"name": "apGroupName2"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP group",
"type": "string"
},
"name": {
"description": "Description of the AP group",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/apgroups/{id}
Use this API command to retrieve information about an AP group.
200
Body
{
"id": "apGroupUUID",
"zoneId": "zoneUUID",
"name": "apGroupName",
"description": "apGroupDescription",
"location": "test-ap1_modify",
"locationAdditionalInfo": "add",
"latitude": 34,
"longitude": 45,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 9,
"channelRange": [
1,
2,
3,
4,
9,
10,
11
],
"availableChannelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 157,
"indoorChannelRange": [
36,
40,
44,
48
],
"outdoorChannelRange": [
149,
153
],
"availableIndoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableOutdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
},
"wlanGroup50": null,
"locationBasedService": null,
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": null,
"venueProfile": null,
"members": [
{
"apMac": "00:11:22:33:44:55"
},
{
"apMac": "11:22:33:44:55:66"
}
],
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP group",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the AP group belongs",
"type": "string"
},
"name": {
"description": "Name of the AP group",
"type": "string"
},
"description": {
"description": "Description of the AP group",
"type": "string"
},
"location": {
"description": "Location of the AP group.",
"type": "string"
},
"locationAdditionalInfo": {
"description": "Location additional info of the AP group.",
"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 AP group",
"type": "number"
},
"longitude": {
"description": "Longitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"wifi24": {
"description": "AP 2.4GHz radio configuration of the AP group.",
"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 AP group.",
"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 AP group.",
"enum": [
"NONE",
"CTS_ONLY",
"RTS_CTS"
],
"default": "RTS_CTS"
},
"wlanGroup24": {
"description": "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"wlanGroup50": {
"description": "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"locationBasedService": {
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"clientAdmissionControl24": {
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"clientAdmissionControl50": {
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"venueProfile": {
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"members": {
"description": "Members of the AP group",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"description": "MAC address of member AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"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 ap group",
"type": "integer",
"default": 600,
"minimum": 60,
"maximum": 3600
},
"apMgmtVlan": {
"description": "ap Management Vlan of the apgroup",
"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"
}
}
},
"awsVenue": {
"description": "Venue code",
"type": "string"
}
},
"required": [
"name"
]
}
Create ¶
POST/v6_1/rkszones/{zoneId}/apgroups
Use this API command to create new AP group within a zone.
Body
{
"name": "apGroupName",
"description": "apGroupDescription"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the AP group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the AP group",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"name"
]
}
201
Body
{
"id": "apGroupUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP group",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}
Use this API command to modify the basic information of an AP group.
Body
{
"name": "apGroupNameModified",
"description": "apGroupDescriptionModified",
"location": "test-ap1_modify",
"locationAdditionalInfo": "add",
"latitude": 34,
"longitude": 45,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 10,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 20,
"indoorChannel": 36,
"outdoorChannel": 149,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
},
"wlanGroup50": {
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
},
"locationBasedService": {
"id": "lbsServiceId",
"name": "lbsServiceName"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"venueProfile": {
"id": "venueProfileId",
"name": "venueProfileName"
},
"members": [
{
"apMac": "00:11:22:33:44:55"
},
{
"apMac": "11:22:33:44:55:66"
}
],
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the AP group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the AP group",
"type": [
"string",
"null"
],
"maxLength": 64
},
"location": {
"description": "Location of the AP group.",
"type": "string"
},
"locationAdditionalInfo": {
"description": "Location additional info of the AP group.",
"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 AP group",
"type": "number"
},
"longitude": {
"description": "Longitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"wifi24": {
"description": "AP 2.4GHz radio configuration of the AP group.",
"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 AP group.",
"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 AP group.",
"enum": [
"NONE",
"CTS_ONLY",
"RTS_CTS"
],
"default": "RTS_CTS"
},
"wlanGroup24": {
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"wlanGroup50": {
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"locationBasedService": {
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"clientAdmissionControl24": {
"description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"clientAdmissionControl50": {
"description": "AP client admission control of 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"venueProfile": {
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"usbSoftwarePackage": {
"description": "APUsbSoftwarePackage of the AP group",
"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 ap group",
"type": "integer",
"default": 600,
"minimum": 60,
"maximum": 3600
},
"apMgmtVlan": {
"description": "ap Management Vlan of the apgroup",
"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"
}
}
},
"awsVenue": {
"description": "Venue code",
"type": "string"
}
}
}
204
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/apgroups/default
Use this API command to retrieve information about default AP group of zone.
200
Body
{
"id": "apGroupUUID",
"zoneId": "zoneUUID",
"name": "apGroupName",
"description": "apGroupDescription",
"location": "test-ap1_modify",
"locationAdditionalInfo": "add",
"latitude": 34,
"longitude": 45,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 9,
"channelRange": [
1,
2,
3,
4,
9,
10,
11
],
"availableChannelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 157,
"indoorChannelRange": [
36,
40,
44,
48
],
"outdoorChannelRange": [
149,
153
],
"availableIndoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableOutdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
},
"wlanGroup50": null,
"locationBasedService": null,
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": null,
"venueProfile": null,
"members": [
{
"apMac": "00:11:22:33:44:55"
},
{
"apMac": "11:22:33:44:55:66"
}
],
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP group",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the AP group belongs",
"type": "string"
},
"name": {
"description": "Name of the AP group",
"type": "string"
},
"description": {
"description": "Description of the AP group",
"type": "string"
},
"location": {
"description": "Location of the AP group.",
"type": "string"
},
"locationAdditionalInfo": {
"description": "Location additional info of the AP group.",
"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 AP group",
"type": "number"
},
"longitude": {
"description": "Longitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"wifi24": {
"description": "AP 2.4GHz radio configuration of the AP group.",
"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 AP group.",
"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 AP group.",
"enum": [
"NONE",
"CTS_ONLY",
"RTS_CTS"
],
"default": "RTS_CTS"
},
"wlanGroup24": {
"description": "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"wlanGroup50": {
"description": "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"locationBasedService": {
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"clientAdmissionControl24": {
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"clientAdmissionControl50": {
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"venueProfile": {
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"members": {
"description": "Members of the AP group",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"description": "MAC address of member AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"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 ap group",
"type": "integer",
"default": 600,
"minimum": 60,
"maximum": 3600
},
"apMgmtVlan": {
"description": "ap Management Vlan of the apgroup",
"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"
}
}
},
"awsVenue": {
"description": "Venue code",
"type": "string"
}
},
"required": [
"name"
]
}
Modify Location Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/location
Use this API command to modify the location override zone for APs that belong to an AP group.
Body
"test-ap1_modify"
Schema
{
"description": "Location of the AP group.",
"type": "string"
}
204
Disable Location Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/location
Use this API command to disable location override for APs that belong to an AP group.
204
Modify Location AdditionalInfo Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo
Use this API command to modify the locationAdditionalInfo override zone for APs that belong to an AP group.
Body
"add"
Schema
{
"description": "Location additional info of the AP group.",
"type": "string",
"pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
204
Disable Location AdditionalInfo Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo
Use this API command to disable location additionalInfo override zone for APs that belong to an AP group.
204
Modify Radio 2.4G Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi24
Use this API command to modify the 2.4GHz radio configuration override zone for APs that belong to an AP group.
Body
{
"txPower": "Full",
"channelWidth": 20,
"channel": 10,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
}
Schema
{
"description": "AP 2.4GHz radio configuration of the AP group.",
"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"
}
}
}
}
204
Disable Radio 2.4G Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi24
Use this API command to disable 2.4GHz radio configuration override zone for APs that belong to an AP group.
204
Disable Radio 2.4G TxPower Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi24/txPower
Use this API command to disable 2.4GHz radio txPower override zone for APs that belong to an AP group.
204
Disable Radio 2.4G ChannelWidth Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi24/channelWidth
Use this API command to disable 2.4GHz radio channelWidth override zone for APs that belong to an AP group.
204
Disable Radio 2.4G Channel Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi24/channel
Use this API command to disable 2.4GHz radio channel override zone for APs that belong to an AP group.
204
Disable Radio 2.4G ChannelRange Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi24/channelRange
Use this API command to disable 2.4GHz radio channelRange override zone for APs that belong to an AP group.
204
Modify Radio 5G Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi50
Use this API command to modify the 5GHz radio configuration override zone for APs that belong to an AP group.
Body
{
"txPower": "Full",
"channelWidth": 20,
"indoorChannel": 36,
"outdoorChannel": 149,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
}
Schema
{
"description": "AP 5GHz radio configuration of the AP group.",
"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"
}
}
}
}
204
Disable Radio 5G Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi50
Use this API command to disable 5GHz radio configuration override zone for APs that belong to an AP group.
204
Disable Radio 5G TxPower Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi50/txPower
Use this API command to disable 5GHz radio txPower override zone for APs that belong to an AP group.
204
Disable Radio 5G ChannelWidth Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi50/channelWidth
Use this API command to disable 5GHz radio channelWidth override zone for APs that belong to an AP group.
204
Disable Radio 5G IndoorChannel Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi50/indoorChannel
Use this API command to disable 5GHz radio indoorChannel override zone for APs that belong to an AP group.
204
Disable Radio 5G OutdoorChannel Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi50/outdoorChannel
Use this API command to disable 5GHz radio outdoorChannel override zone for APs that belong to an AP group.
204
Disable Radio 5G IndoorChannelRange Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi50/indoorChannelRange
Use this API command to disable 5GHz radio indoorChannelRange override zone for APs that belong to an AP group.
204
Disable Radio 5G OutdoorChannelRange Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wifi50/outdoorChannelRange
Use this API command to disable 5GHz radio outdoorChannelRange override zone for APs that belong to an AP group.
204
Modify WLAN group 2.4G Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24
Use this API command to modify the WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.
Body
{
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
}
Schema
{
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable WLAN group 2.4G Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24
Use this API command to disable WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.
204
Modify WLAN group 5G Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50
Use this API command to modify the WLAN group on 5GHz radio override zone for APs that belong to an AP group.
Body
{
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
}
Schema
{
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable WLAN group 5G Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50
Use this API command to disable WLAN group on 5GHz radio override zone for APs that belong to an AP group.
204
Modify Location Based Service Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService
Use this API command to modify location based service override zone for APs that belong to an AP group.
Body
{
"id": "lbsServiceId",
"name": "lbsServiceName"
}
Schema
{
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable Location Based Service Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService
Use this API command to disable location based service override zone for APs that belong to an AP group.
204
Modify Client Admission Control 2.4G Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24
Use this API command to modify client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
}
Schema
{
"description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
}
204
Disable Client Admission Control 2.4G Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24
Use this API command to disable client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.
204
Modify Client Admission Control 5G Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50
Use this API command to modify client admission control 5GHz radio configuration override zone for APs that belong to an AP group.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
}
Schema
{
"description": "AP client admission control of 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
}
204
Disable Client Admission Control 5G Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50
Use this API command to disable client admission control 5GHz radio configuration override zone for APs that belong to an AP group.
204
Modify Hotspot2.0 Venue Profile ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/venueProfile
Use this API command to modify Hotspot 2.0 venue profile for APs that belong to an AP group.
Body
{
"id": "venueProfileId",
"name": "venueProfileName"
}
Schema
{
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Clear Hotspot2.0 Venue Profile ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/venueProfile
Use this API command to clear Hotspot 2.0 venue profile for APs that belong to an AP group.
204
Disable 2.4GHz radio protection mode override. ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/protectionMode24
Use this API command to disable 2.4GHz radio protection mode configuration override zone for APs that belong to an AP group.
204
Add Member ¶
POST/v6_1/rkszones/{zoneId}/apgroups/{id}/members/{apMac}
Use this API command to add a member AP to an AP group.
201
Add Member List ¶
POST/v6_1/rkszones/{zoneId}/apgroups/{id}/members
Add multiple members to an AP group.
Body
{
"memberList": [
{
"apMac": "00:22:11:0C:BD:13"
},
{
"apMac": "10:11:22:0C:0D:15"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"memberList": {
"description": "List of apMac",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"description": "MAC address of member AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
}
}
201
Remove Member ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/members/{apMac}
Use this API command to remove a member AP from an AP group.
204
Retrieve AP Model ¶
GET/v6_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}
Use this API command to retrieve AP model specific configuration override zone that belong to an AP group, NULL means the override setting is not checked inside an AP group.
200
Body
{
"ledStatusEnabled": true,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 30,
"holdTimeInSec": 120,
"managementIPTLVEnabled": false
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": false,
"ethPortProfile": null
},
{
"portName": "LAN2",
"enabled": true,
"ethPortProfile": {
"id": "0",
"name": "Default Trunk Port"
}
},
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1",
"name": "Default Access Port"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"ledMode": {
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"enum": [
null,
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus"
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default": 2,
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}
Override AP Model ¶
PUT/v6_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}
Use this API command to modify AP model specific configuration override zone that belong to an AP group.
Body
{
"ledStatusEnabled": true,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 30,
"holdTimeInSec": 120,
"managementIPTLVEnabled": false
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": false,
"ethPortProfile": null
},
{
"portName": "LAN2",
"enabled": true,
"ethPortProfile": {
"id": "0",
"name": "Default Trunk Port"
}
},
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1",
"name": "Default Access Port"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"ledMode": {
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"enum": [
null,
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus"
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default": 2,
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}
204
Disable Override AP Model ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}
Use this API command to disable AP model specific configuration override zone that belong to an AP group.
204
Modify Radio 2.4G Auto ChannelSelectMode Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24
Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP group.
Body
{
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
}
Schema
{
"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
}
}
}
204
Modify Radio 5G Auto ChannelSelectMode Override ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50
Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP group.
Body
{
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
}
Schema
{
"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
}
}
}
204
Disable Radio 2.4G Auto ChannelSelectMode Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24
Disable Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group.
204
Disable Radio 5G Auto ChannelSelectMode Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50
Disable Radio 5G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group.
204
Disable Channel Evaluation Interval Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/channelEvaluationInterval
Disable Channel Evaluation Interval Override of an AP group.
204
Modify AP Usb Software Package ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/usbSoftwarePackage
Modify AP Usb Software Package of an AP group.
Schema
{
"description": "APUsbSoftwarePackage of the AP group",
"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"
}
}
}
}
204
Disable AP Usb Software Package ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/usbSoftwarePackage
Disable AP Usb Software Package of an AP group.
- applyModel
string
(optional)Specify ap models. ex : applyModel=ZF7321U&applyModel=ZF7323
204
Modify AP Management Vlan ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/apMgmtVlan
Modify AP Management Vlan of an AP group.
Body
{
"id": 1,
"mode": "KEEP"
}
Schema
{
"description": "ap Management Vlan of the apgroup",
"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"
}
}
}
204
Disable AP Management Vlan Override ¶
DELETE/v6_1/rkszones/{zoneId}/apgroups/{id}/apMgmtVlan
Disable AP Management Vlan Override of an AP group.
204
Modify Altitude of ApGroup ¶
PATCH/v6_1/rkszones/{zoneId}/apgroups/{id}/altitude
Use this API command to modify the altitude of AP group.
Body
{
"altitudeUnit": "meters",
"altitudeValue": 1
}
Schema
{
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"enum": [
"meters",
"floor"
]
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
}
204
Access Point Configuration ¶
Retrieve List ¶
GET/v6_1/aps
Use this API command to retrieve the list of APs that belong to a zone or a domain.
- 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
- zoneId
string
(optional)filter AP list by zone
- domainId
string
(optional)filter AP list by domain. Default: current logon domain
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"mac": "00:11:22:33:44:55",
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"name": "apName"
},
{
"mac": "11:22:33:44:55:66",
"zoneId": "zoneUUID2",
"apGroupId": "apGroupUUID2",
"name": "apName2"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total AP count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more APs after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first AP returned out of the complete AP list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "MAC address of the AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId": {
"description": "ap.moveAP.properties.zoneId.description",
"type": "string"
},
"apGroupId": {
"description": "Identifier of the AP group to which the AP belongs",
"type": "string"
},
"name": {
"description": "Name of the AP",
"type": "string"
},
"serial": {
"description": "Serial Number",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/aps/{apMac}
Use this API command to retrieve the configuration of an AP.
200
Body
{
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"serial": "00000096",
"model": "ZF7343",
"name": "apName",
"gpsSource": "MANUAL",
"latitude": 22.3,
"longitude": 114,
"location": "location",
"description": "apDescription",
"administrativeState": "Unlocked",
"provisionChecklist": "provisionChecklist",
"login": {
"apLoginName": "apLoginName",
"apLoginPassword": "apLoginPassword"
},
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 1,
"channelRange": [
1,
2,
3
],
"availableChannelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 20,
"channel": 52,
"channelRange": [
52,
56,
60
],
"availableChannelRange": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
132,
136,
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "wlanGroupUUID",
"name": "wlanGroupName"
},
"wlanGroup50": {
"id": "wlanGroupUUID",
"name": "wlanGroupName"
},
"network": {
"ipType": "Static",
"ip": "1.1.1.1",
"netmask": "255.255.255.0",
"gateway": "1.1.1.0",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.8.9"
},
"networkIpv6": {
"ipType": "Static",
"ip": "2001::55/32",
"gateway": "2001::66",
"primaryDns": "2001::77",
"secondaryDns": "2001::88"
},
"smartMonitor": {
"enabled": true,
"intervalInSec": 10,
"retryThreshold": 10
},
"bonjourGateway": {
"id": "bonjourGatewayUUID",
"name": "bonjourGatewayName"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"specific": {
"ledStatusEnabled": false,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 100,
"holdTimeInSec": 1000,
"managementIPTLVEnabled": false
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": true,
"type": "Trunk",
"vlanUntagId": 13,
"members": "1-4094",
"_8021X": {
"type": "Disable",
"authenticator": null,
"supplicant": null
}
},
{
"portName": "LAN2",
"enabled": true,
"type": "Access",
"vlanUntagId": 15,
"members": "15",
"_8021X": {
"type": "MACBasedAuthenticator",
"authenticator": {
"authentication": {
"id": "5f66275c-b1fd-4e25-a4db-b64115740fb9",
"name": "zoneRadius"
},
"accounting": {
"id": "b86db5e8-884b-4c90-9315-dcd72acaf743",
"name": "zoneRadiusAcct"
},
"macAuthByPassEnabled": true
},
"supplicant": null
}
},
{
"portName": "LAN3",
"enabled": true,
"type": "Trunk",
"vlanUntagId": 1,
"members": "1-4094",
"_8021X": {
"type": "Supplicant",
"authenticator": null,
"supplicant": {
"type": "Custom",
"userName": "a",
"password": "a"
}
}
}
]
},
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"meshOptions": {
"meshMode": "MESH_AP",
"uplinkSelection": "MANUAL",
"meshUplinkEntryList": [
"6C:AA:B3:26:6C:30"
]
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"description" : "MAC address of the AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId" : {
"description" : "Identifier of the AP group to which the AP belongs",
"type" : "string"
},
"apGroupId" : {
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"description" : "Name of the AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"description" : {
"description" : "Description of the AP",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"gpsSource" : {
"description" : "GPS Source of the AP",
"enum" : [ "GPS", "MANUAL" ]
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"location" : {
"description" : "Location of the AP. It is a text description to indicate the location of the AP.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
"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"
}
}
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"type" : "string"
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"enum" : [ "Locked", "Unlocked" ],
"default" : "Unlocked"
},
"userLocationInfo" : {
"description" : "User location information",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"areaCode" : {
"description" : "Area code",
"type" : "integer"
},
"cellId" : {
"description" : "Cell identifier",
"type" : "integer"
}
}
},
"wlanService24Enabled" : {
"description" : "WLAN service enabled or disabled on 2.4GHz radio",
"type" : "boolean"
},
"wlanService50Enabled" : {
"description" : "WLAN service enabled or disabled on 5GHz radio",
"type" : "boolean"
},
"login" : {
"description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"syslog" : {
"description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Indicates whether syslog is enabled or disabled",
"type" : "boolean"
},
"address" : {
"description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
"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" ]
},
"priority" : {
"description" : "Priority of the log messages",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
},
"required" : [ "enabled" ]
},
"wifi24" : {
"description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level.",
"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" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "common.apRadio50SuperSet.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, 0 mean Auto, 8080 means 80+80MHz",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"channel" : {
"description" : "channel number",
"type" : "integer"
},
"secondaryChannel" : {
"description" : "channel number (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"channelRange" : {
"description" : "channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableChannelRange" : {
"description" : "available channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the AP.",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"wlanGroup24" : {
"description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
}
},
"wlanGroup50" : {
"description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
}
},
"network" : {
"description" : "Network settings ipv4 of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"netmask" : {
"description" : "Netmask of the AP's subnet",
"type" : "string",
"pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"gateway" : {
"description" : "Gateway of the AP",
"type" : "string"
},
"primaryDns" : {
"description" : "Primary DNS server address of the AP",
"type" : "string"
},
"secondaryDns" : {
"description" : "Secondary DNS server address of the AP",
"type" : "string"
}
}
},
"networkIpv6" : {
"description" : "Network settings ipv6 of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"gateway" : {
"description" : "Gateway of the AP",
"type" : "string"
},
"primaryDns" : {
"description" : "Primary DNS server address of the AP",
"type" : "string"
},
"secondaryDns" : {
"description" : "Secondary DNS server address of the AP",
"type" : "string"
}
}
},
"smartMonitor" : {
"description" : "Smart monitor of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
}
},
"bonjourGateway" : {
"description" : "Bonjour gateway of the AP.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"clientAdmissionControl24" : {
"description" : "Client admission control configuration of 2.4GHz radio of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "Client admission control configuration of 5GHz radio of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the AP.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"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 AP",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan",
"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"
}
}
},
"specific" : {
"description" : "Model specific configuration of the AP",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ledStatusEnabled" : {
"type" : [ "boolean", "null" ]
},
"lldp" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean",
"default" : true
},
"advertiseIntervalInSec" : {
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 300
},
"holdTimeInSec" : {
"type" : [ "integer", "null" ],
"minimum" : 60,
"maximum" : 1200
},
"managementIPTLVEnabled" : {
"type" : [ "boolean", "null" ]
}
},
"required" : [ "enabled" ]
},
"ledMode" : {
"enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
},
"internalHeaterEnabled" : {
"type" : [ "boolean", "null" ]
},
"poeOutPortEnabled" : {
"type" : [ "boolean", "null" ]
},
"usbPowerEnable" : {
"type" : [ "boolean", "null" ]
},
"poeModeSetting" : {
"enum" : [ "Auto", "_802_3af", "_802_3at", "_802_3atPlus", null ]
},
"poeTxChain" : {
"description" : "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default" : 2,
"type" : [ "integer", "null" ]
},
"radioBand" : {
"description" : "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"enum" : [ null, "2.4GHz", "5GHz" ]
},
"externalAntenna24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"externalAntenna50" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"lanPorts" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portName" : {
"enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
},
"enabled" : {
"type" : "boolean"
},
"overwriteVlanEnabled" : {
"type" : "boolean"
},
"vlanUntagId" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4094
},
"members" : {
"type" : [ "string", "null" ]
},
"ethPortProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "portName", "enabled" ]
}
}
}
},
"meshOptions" : {
"description" : "mesh options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"meshMode" : {
"description" : "mesh mode",
"enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
},
"uplinkSelection" : {
"description" : "Uplink selection",
"enum" : [ "SMART", "MANUAL" ]
},
"meshUplinkEntryList" : {
"description" : "MAC address of the neighbor AP",
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
}
}
Retrieve AP Picture ¶
Create ¶
POST/v6_1/aps
Use this API command to create a new access point.
Body
{
"mac": "00:11:22:33:44:55",
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"serial": "00000096",
"model": "ZF7962",
"name": "apName",
"gpsSource": "MANUAL",
"latitude": 22.3,
"longitude": 114,
"location": "shenzhen",
"description": "apDescription",
"administrativeState": "Unlocked",
"provisionChecklist": "test"
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"description" : "MAC address of the AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId" : {
"description" : "ap.moveAP.properties.zoneId.description",
"type" : "string"
},
"apGroupId" : {
"description" : "Identifier of the AP group to which the AP belongs. If the AP belongs to the default AP group, this property is not needed.",
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"description" : "Name of the AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"gpsSource" : {
"description" : "GPS Source of the AP",
"enum" : [ "GPS", "MANUAL" ]
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"location" : {
"description" : "Location of the AP. This is a free format text description that indicates the location of the AP.",
"type" : "string"
},
"description" : {
"description" : "Description of the AP",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"enum" : [ "Locked", "Unlocked" ],
"default" : "Unlocked"
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"type" : "string"
}
},
"required" : [ "mac", "zoneId" ]
}
201
Modify ¶
PATCH/v6_1/aps/{apMac}
Use this API command to modify the basic information of an AP.
Body
{
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"serial": "00000096",
"model": "ZF7343",
"name": "apName",
"gpsSource": "MANUAL",
"latitude": 22.3,
"longitude": 114,
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"description": "apDescription",
"administrativeState": "Unlocked",
"provisionChecklist": "provisionChecklist",
"wlanService24Enabled": true,
"wlanService50Enabled": false,
"login": {
"apLoginName": "apLoginName",
"apLoginPassword": "test1@pwd"
},
"syslog": {
"enabled": true,
"address": "1.1.1.1",
"port": 514,
"facility": "Keep_Original",
"priority": "Error"
},
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 1,
"channelRange": [
1,
2,
3
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 20,
"channel": 52,
"channelRange": [
52,
56,
60
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "wlanGroupUUID",
"name": "wlanGroupName"
},
"wlanGroup50": {
"id": "wlanGroupUUID",
"name": "wlanGroupName"
},
"network": {
"ipType": "Static",
"ip": "1.1.1.1",
"netmask": "255.255.255.0",
"gateway": "1.1.1.0",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.8.9"
},
"networkIpv6": {
"ipType": "Static",
"ip": "2001::55/32",
"gateway": "2001::66",
"primaryDns": "2001::77",
"secondaryDns": "2001::88"
},
"smartMonitor": {
"enabled": true,
"intervalInSec": 10,
"retryThreshold": 10
},
"bonjourGateway": {
"id": "bonjourGatewayUUID",
"name": "bonjourGatewayName"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"venueProfile": {
"id": "venueProfileId",
"name": "venueProfileName"
},
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"meshOptions": {
"meshMode": "MESH_AP",
"uplinkSelection": "MANUAL",
"meshUplinkEntryList": [
"6C:AA:B3:26:6C:30"
]
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"zoneId" : {
"description" : "ap.moveAP.properties.zoneId.description",
"type" : "string"
},
"apGroupId" : {
"description" : "Identifier of the AP group to which the AP belongs",
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"description" : "Name of the AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"gpsSource" : {
"description" : "GPS Source of the AP",
"enum" : [ "GPS", "MANUAL" ]
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"location" : {
"description" : "Location of the AP. This is a text description that indicates the location of the AP.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
"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"
}
}
},
"description" : {
"description" : "Description of the AP",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"enum" : [ "Locked", "Unlocked" ]
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"type" : "string"
},
"userLocationInfo" : {
"description" : "User location information of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"areaCode" : {
"description" : "area code",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"wlanService24Enabled" : {
"description" : "WLAN service enabled or disabled on 2.4GHz radio",
"type" : "boolean"
},
"wlanService50Enabled" : {
"description" : "WLAN service enabled or disabled on 5GHz radio",
"type" : "boolean"
},
"login" : {
"description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"syslog" : {
"description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Indicates whether syslog is enabled or disabled",
"type" : "boolean"
},
"address" : {
"description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
"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" ]
},
"priority" : {
"description" : "Priority of the log messages",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
},
"required" : [ "enabled" ]
},
"wifi24" : {
"description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level.",
"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" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "common.apRadio50.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, 0 mean Auto, 8080 means 80+80MHz",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"channel" : {
"description" : "channel number",
"type" : "integer"
},
"secondaryChannel" : {
"description" : "channel number (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"channelRange" : {
"description" : "channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the AP.",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"wlanGroup24" : {
"description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
}
},
"wlanGroup50" : {
"description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
}
},
"network" : {
"description" : "Network settings ipv4 of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"netmask" : {
"description" : "Netmask of the AP's subnet",
"type" : "string",
"pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"gateway" : {
"description" : "Gateway of the AP",
"type" : "string"
},
"primaryDns" : {
"description" : "Primary DNS server address of the AP",
"type" : "string"
},
"secondaryDns" : {
"description" : "Secondary DNS server address of the AP",
"type" : "string"
}
}
},
"networkIpv6" : {
"description" : "Network settings ipv6 of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"gateway" : {
"description" : "Gateway of the AP",
"type" : "string"
},
"primaryDns" : {
"description" : "Primary DNS server address of the AP",
"type" : "string"
},
"secondaryDns" : {
"description" : "Secondary DNS server address of the AP",
"type" : "string"
}
}
},
"smartMonitor" : {
"description" : "Smart monitor of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
}
},
"bonjourGateway" : {
"description" : "Bonjour gateway of the AP.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"clientAdmissionControl24" : {
"description" : "Client admission control configuration of 2.4GHz radio of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "Client admission control configuration of 5GHz radio of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the AP.",
"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 AP",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan",
"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"
}
}
},
"meshOptions" : {
"description" : "mesh options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"meshMode" : {
"description" : "mesh mode",
"enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
},
"uplinkSelection" : {
"description" : "Uplink selection",
"enum" : [ "SMART", "MANUAL" ]
},
"meshUplinkEntryList" : {
"description" : "MAC address of the neighbor AP",
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
}
}
204
Disable Location Override ¶
DELETE/v6_1/aps/{apMac}/location
Use this API command to disable AP level override of location. The access point will take its group’s configuration or zone’s configuration.
204
Disable Location AdditionalInfo Override ¶
DELETE/v6_1/aps/{apMac}/locationAdditionalInfo
Use this API command to disable AP level override of location additionalInfo. The access point will take its group’s configuration or zone’s configuration.
204
Modify Login Override ¶
PATCH/v6_1/aps/{apMac}/login
Use this API command to enable or modify the AP-level logon override settings.
Body
{
"apLoginName": "apLoginName",
"apLoginPassword": "test1@pwd"
}
Schema
{
"description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
"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])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
}
204
Disable Login Override ¶
DELETE/v6_1/aps/{apMac}/login
Use this API command to disable the AP-level logon override. The AP will apply its group’s or zone’s configuration.
204
Modify Syslog Override ¶
PATCH/v6_1/aps/{apMac}/syslog
Use this API command to enable or modify the AP-level syslog override settings.
Body
{
"enabled": true,
"address": "1.1.1.1",
"port": 514,
"facility": "Keep_Original",
"priority": "Error"
}
Schema
{
"description": "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Indicates whether syslog is enabled or disabled",
"type": "boolean"
},
"address": {
"description": "Address of the syslog server. If syslog is enabled, this attribute is required.",
"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"
]
},
"priority": {
"description": "Priority of the log messages",
"enum": [
"Emergency",
"Alert",
"Critical",
"Error",
"Warning",
"Notice",
"Info",
"All"
]
}
},
"required": [
"enabled"
]
}
204
Disable Syslog Override ¶
DELETE/v6_1/aps/{apMac}/syslog
Use this API command to disable the AP level syslog override. The access point will take its group’s or zone’s configuration.
204
Modify Radio 2.4G Override ¶
PATCH/v6_1/aps/{apMac}/wifi24
Use this API command to modify the AP level override of the 2.4GHz radio configuration.
Body
{
"txPower": "Full",
"channelWidth": 20,
"channel": 1,
"channelRange": [
1,
2,
3
]
}
Schema
{
"description": "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level.",
"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"
}
}
}
}
204
Disable Radio 2.4G Override ¶
DELETE/v6_1/aps/{apMac}/wifi24
Use this API command to disable the AP level override of the 2.4GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.
204
Disable Radio 2.4G TxPower Override ¶
DELETE/v6_1/aps/{apMac}/wifi24/txPower
Use this API command to disable the AP level override of the 2.4GHz radio txPower. The access point will take its group’s configuration or zone’s configuration.
204
Disable Radio 2.4G ChannelWidth Override ¶
DELETE/v6_1/aps/{apMac}/wifi24/channelWidth
Use this API command to disable the AP level override of the 2.4GHz radio channelWidth. The access point will take its group’s configuration or zone’s configuration.
204
Disable Radio 2.4G Channel Override ¶
DELETE/v6_1/aps/{apMac}/wifi24/channel
Use this API command to disable the AP level override of the 2.4GHz radio channel. The access point will take its group’s configuration or zone’s configuration.
204
Disable Radio 2.4G ChannelRange Override ¶
DELETE/v6_1/aps/{apMac}/wifi24/channelRange
Use this API command to disable the AP level override of the 2.4GHz radio channelRange. The access point will take its group’s configuration or zone’s configuration.
204
Modify Radio 5G Override ¶
PATCH/v6_1/aps/{apMac}/wifi50
Use this API command to Modify the AP level override of the 5GHz radio configuration.
Body
{
"txPower": "Full",
"channelWidth": 20,
"channel": 52,
"channelRange": [
52,
56,
60
]
}
Schema
{
"description": "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "common.apRadio50.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, 0 mean Auto, 8080 means 80+80MHz",
"enum": [
0,
20,
40,
80,
8080,
160
]
},
"channel": {
"description": "channel number",
"type": "integer"
},
"secondaryChannel": {
"description": "channel number (channelWidth is 80+80MHz only)",
"type": "integer"
},
"channelRange": {
"description": "channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
}
204
Disable Radio 5G Override ¶
DELETE/v6_1/aps/{apMac}/wifi50
Use this API command to disable the AP level override of 5GHz radio configuration. The access point will take its group’s or zone’s configuration.
204
Disable Radio 5G TxPower Override ¶
DELETE/v6_1/aps/{apMac}/wifi50/txPower
Use this API command to disable the AP level override of 5GHz radio txPower. The access point will take its group’s or zone’s configuration.
204
Disable Radio 5G ChannelWidth Override ¶
DELETE/v6_1/aps/{apMac}/wifi50/channelWidth
Use this API command to disable the AP level override of 5GHz radio channelWidth. The access point will take its group’s or zone’s configuration.
204
Disable Radio 5G Channel Override ¶
DELETE/v6_1/aps/{apMac}/wifi50/channel
Use this API command to disable the AP level override of 5GHz radio channel. The access point will take its group’s or zone’s configuration.
204
Disable Radio 5G ChannelRange Override ¶
DELETE/v6_1/aps/{apMac}/wifi50/channelRange
Use this API command to disable the AP level override of 5GHz radio channelRange. The access point will take its group’s or zone’s configuration.
204
Modify WLAN Group 2.4G Override ¶
PATCH/v6_1/aps/{apMac}/wlanGroup24
Use this API command to enable or modify the AP level override of the WLAN group configuration on the 2.4GHz radio.
Body
{
"id": "wlanGroupUUID",
"name": "wlanGroupName"
}
Schema
{
"description": "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
},
"name": {
"description": "Name of the WLAN group",
"type": "string"
}
}
}
204
Disable WLAN Group 2.4G Override ¶
DELETE/v6_1/aps/{apMac}/wlanGroup24
Use this API command to disable the AP level override of WLAN group configuration on 2.4GHz radio. The access point will take its group’s or zone’s configuration.
204
Modify WLAN Group 5G Override ¶
PATCH/v6_1/aps/{apMac}/wlanGroup50
Use this API command to enable or modify the AP level override of the WLAN group configuration on the 5GHz radio.
Body
{
"id": "wlanGroupUUID",
"name": "wlanGroupName"
}
Schema
{
"description": "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
},
"name": {
"description": "Name of the WLAN group",
"type": "string"
}
}
}
204
Disable WLAN group 5G Override ¶
DELETE/v6_1/aps/{apMac}/wlanGroup50
Use this API command to disable the AP level override of WLAN group on the 5GHz radio. The access point will take its group’s or zone’s configuration.
204
Modify Network Settings Ipv4 ¶
PATCH/v6_1/aps/{apMac}/network
Use this API command to modify the network settings Ipv4 of an AP.
Body
{
"ipType": "Static",
"ip": "1.1.1.1",
"netmask": "255.255.255.0",
"gateway": "1.1.1.0",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.8.9"
}
Schema
{
"description": "Network settings ipv4 of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"ipType": {
"description": "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum": [
"Static",
"Dynamic",
"Autoconfig",
"Keep"
]
},
"ip": {
"description": "IP address of the AP",
"type": "string"
},
"netmask": {
"description": "Netmask of the AP's subnet",
"type": "string",
"pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"gateway": {
"description": "Gateway of the AP",
"type": "string"
},
"primaryDns": {
"description": "Primary DNS server address of the AP",
"type": "string"
},
"secondaryDns": {
"description": "Secondary DNS server address of the AP",
"type": "string"
}
}
}
204
Modify Network Settings Ipv6 ¶
PATCH/v6_1/aps/{apMac}/networkIpv6
Use this API command to modify the network settings Ipv6 of an AP.
Body
{
"ipType": "Static",
"ip": "2001::55/32",
"gateway": "2001::66",
"primaryDns": "2001::77",
"secondaryDns": "2001::88"
}
Schema
{
"description": "Network settings ipv6 of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"ipType": {
"description": "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum": [
"Static",
"Dynamic",
"Autoconfig",
"Keep"
]
},
"ip": {
"description": "IP address of the AP",
"type": "string"
},
"gateway": {
"description": "Gateway of the AP",
"type": "string"
},
"primaryDns": {
"description": "Primary DNS server address of the AP",
"type": "string"
},
"secondaryDns": {
"description": "Secondary DNS server address of the AP",
"type": "string"
}
}
}
204
Modify Smart Monitor ¶
PATCH/v6_1/aps/{apMac}/smartMonitor
Use this API command to modify smart monitor of an AP.
Body
{
"enabled": true,
"intervalInSec": 10,
"retryThreshold": 10
}
Schema
{
"description": "Smart monitor of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"intervalInSec": {
"description": "Interval in seconds. This is required if smartMonitor is enabled",
"type": "integer",
"default": 10,
"minimum": 5,
"maximum": 60
},
"retryThreshold": {
"description": "Retry threshold. This is required if smartMonitor is enabled",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
}
204
Disable Smart Monitor Override ¶
DELETE/v6_1/aps/{apMac}/smartMonitor
Use this API command to disable AP level override of smart monitor. The access point will take its group’s configuration or zone’s configuration.
204
Modify Bonjour Gateway ¶
PATCH/v6_1/aps/{apMac}/bonjourGateway
Use this API command to modify bonjour gateway of an AP.
Body
{
"id": "bonjourGatewayUUID",
"name": "bonjourGatewayName"
}
Schema
{
"description": "Bonjour gateway of the AP.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable Bonjour Gateway Override ¶
DELETE/v6_1/aps/{apMac}/bonjourGateway
Use this API command to disable AP level override of bonjour gateway. The access point will take its group’s configuration or zone’s configuration.
204
Modify Client Admission Control 2.4G ¶
PATCH/v6_1/aps/{apMac}/clientAdmissionControl24
Use this API command to modify client admission control 2.4GHz radio configuration of an AP.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
}
Schema
{
"description": "Client admission control configuration of 2.4GHz radio of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
}
204
Disable Client Admission Control 2.4G Override ¶
DELETE/v6_1/aps/{apMac}/clientAdmissionControl24
Use this API command to disable AP level override of client admission control 2.4GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.
204
Modify Client Admission Control 5G ¶
PATCH/v6_1/aps/{apMac}/clientAdmissionControl50
Use this API command to modify client admission control 5GHz radio configuration of an AP.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
}
Schema
{
"description": "Client admission control configuration of 5GHz radio of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
}
204
Disable Client Admission Control 5G Override ¶
DELETE/v6_1/aps/{apMac}/clientAdmissionControl50
Use this API command to disable AP level override of client admission control 5GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.
204
Modify Venue Profile ¶
PATCH/v6_1/aps/{apMac}/venueProfile
Use this API command to modify venue profile of an AP.
Body
{
"id": "venueProfileId",
"name": "venueProfileName"
}
Schema
{
"description": "Venue profile configuration of the AP.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable Venue Profile Override ¶
DELETE/v6_1/aps/{apMac}/venueProfile
Use this API command to disable AP level override of venue profile. The access point will take its group’s configuration or zone’s configuration.
204
Modify User Location Info ¶
PATCH/v6_1/aps/{apMac}/userLocationInfo
Use this API command to modify user location info of an AP.
Schema
{
"description": "User location information of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"areaCode": {
"description": "area code",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
}
}
204
Modify Specific ¶
PUT/v6_1/aps/{apMac}/specific
Use this API command to modify specific configuration.
Body
{
"ledStatusEnabled": false,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 100,
"holdTimeInSec": 1000,
"managementIPTLVEnabled": false
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": {
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1"
},
"overwriteVlanEnabled": true,
"vlanUntagId": 1,
"members": "1"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"ledMode": {
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"enum": [
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus",
null
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default": 2,
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"overwriteVlanEnabled": {
"type": "boolean"
},
"vlanUntagId": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 4094
},
"members": {
"type": [
"string",
"null"
]
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}
204
Disable Specific Override ¶
DELETE/v6_1/aps/{apMac}/specific
Use this API command to disable specific configuration override from AP group or zone.
204
Upload AP Picture ¶
Modify AP Picture ¶
PUT/v5_0/aps/{apMac}/picture
Use this API command to modify an AP picture.
Deprecated : this URI will be deprecated after Version: v5_0, not support.
204
Delete AP Picture ¶
Modify AP Usb Software Package ¶
PATCH/v6_1/aps/{apMac}/usbSoftwarePackage
Modify AP Usb Software Package of an access point.
Schema
{
"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"
}
}
}
}
204
Disable AP Usb Software Package ¶
DELETE/v6_1/aps/{apMac}/usbSoftwarePackage
Disable AP level Usb Software Package. The access point will take its group’s configuration or zone’s configuration.
204
Disable AP Channel Evaluation Interval ¶
DELETE/v6_1/aps/{apMac}/channelEvaluationInterval
Disable AP lChannel Evaluation Interval. The access point will take its group’s configuration or zone’s configuration.
204
Modify Radio 2.4G Auto ChannelSelectMode Override ¶
PATCH/v6_1/aps/{apMac}/autoChannelSelection24
Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP.
Body
{
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
}
Schema
{
"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
}
}
}
204
Disable Radio 2.4G Auto channel selection ¶
DELETE/v6_1/aps/{apMac}/autoChannelSelection24
Use this API command to disable the AP level override of auto channel selection on the 2.4GHz radio. The access point will take its group’s or zone’s configuration.
204
Modify Radio 5G Auto ChannelSelectMode Override ¶
PATCH/v6_1/aps/{apMac}/autoChannelSelection50
Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP.
Body
{
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
}
Schema
{
"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
}
}
}
204
Disable Radio 5G Auto channel selection ¶
DELETE/v6_1/aps/{apMac}/autoChannelSelection50
Use this API command to disable the AP level override of auto channel selection on the 5GHz radio. The access point will take its group’s or zone’s configuration.
204
Modify AP Management Vlan ¶
PATCH/v6_1/aps/{apMac}/apMgmtVlan
Modify AP Management Vlan of an AP.
Body
{
"id": 1,
"mode": "KEEP"
}
Schema
{
"description": "ap Management Vlan",
"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"
}
}
}
204
Disable AP Management Vlan Override ¶
Modify Altitude Override ¶
PATCH/v6_1/aps/{apMac}/altitude
Use this API command to modify the altitude of an AP.
Body
{
"altitudeUnit": "meters",
"altitudeValue": 1
}
Schema
{
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"enum": [
"meters",
"floor"
]
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
}
204
Disable Altitude Override ¶
DELETE/v6_1/aps/{apMac}/altitude
Use this API command to disable AP level override of altitude. The access point will take its group’s configuration or zone’s configuration.
204
Modify Mesh Options ¶
PATCH/v6_1/aps/{apMac}/meshOptions
Use this API command to modify mesh options of an AP.
Body
{
"meshMode": "MESH_AP",
"uplinkSelection": "MANUAL",
"meshUplinkEntryList": [
"6C:AA:B3:26:6C:30"
]
}
Schema
{
"description": "mesh options",
"type": "object",
"additionalProperties": false,
"properties": {
"meshMode": {
"description": "mesh mode",
"enum": [
"AUTO",
"ROOT_AP",
"MESH_AP",
"DISABLE"
]
},
"uplinkSelection": {
"description": "Uplink selection",
"enum": [
"SMART",
"MANUAL"
]
},
"meshUplinkEntryList": {
"description": "MAC address of the neighbor AP",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
204
Disable Mesh Options ¶
Disable AP Management GPS Cooordinates ¶
Access Point Operational ¶
Retrieve Operational Information ¶
GET/v6_1/aps/{apMac}/operational/summary
Use this API command to retrieve the operational information of an AP.
200
Body
{
"mac": "00:11:22:33:44:55",
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"serial": "00000096",
"model": "ZF7962",
"name": "apName",
"version": "3.0.0.385",
"description": "apDescription",
"countryCode": "US",
"latitude": 22.3,
"longitude": 114,
"location": "location",
"cpId": "controlPlaneUUID",
"dpId": "dataPlaneUUID",
"wifi24Channel": "2",
"wifi50Channel": "6",
"meshRole": "Map",
"meshHop": 2,
"ipType": "Static",
"ip": "1.1.1.1",
"ipv6Type": null,
"ipv6": null,
"externalIp": "172.18.11.11",
"externalPort": 675,
"configState": "newConfig",
"connectionState": "Connected",
"registrationState": "Approved",
"administrativeState": "Unlocked",
"provisionMethod": "Discovered",
"provisionStage": "Waiting for Registration",
"isCriticalAP": true,
"approvedTime": 111111,
"lastSeenTime": 111111,
"uptime": 111111,
"clientCount": 2
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"description" : "MAC address of the AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId" : {
"description" : "Identifier of the zone to which the AP belongs",
"type" : "string"
},
"apGroupId" : {
"description" : "Identifier of the AP group to which the AP belongs",
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"description" : "Name of the AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"description" : {
"description" : "Description of the AP",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"version" : {
"description" : "Firmware version of the AP",
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
},
"countryCode" : {
"description" : "Country code of the AP",
"type" : "string"
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"location" : {
"description" : "Location of the AP. This is a text description that indicates the location of the AP.",
"type" : "string"
},
"cpId" : {
"description" : "Identifier of the control plane to which the AP is currently connected",
"type" : "string"
},
"dpId" : {
"description" : "Identifier of the data plane to which the AP is currently connected",
"type" : "string"
},
"wifi24Channel" : {
"description" : "2.4GHz radio channel number that the AP is currently using",
"type" : "string"
},
"wifi50Channel" : {
"description" : "5GHZ radio channel number that the AP is currently using",
"type" : "string"
},
"meshRole" : {
"description" : "Mesh role of the AP",
"enum" : [ "Disabled", "Root", "Map", "eMap", "Down", "Undefined" ]
},
"meshHop" : {
"description" : "Number of mesh hops of the AP. This is only applicable to mesh APs.",
"type" : "integer"
},
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum" : [ "Static", "Dynamic", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"ipv6Type" : {
"description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum" : [ "Static", "Autoconfig", "Keep" ]
},
"ipv6" : {
"description" : "IP address of the AP",
"type" : "string"
},
"externalIp" : {
"description" : "External IP address of the AP. This is only applicable when the AP is behind a NAT server.",
"type" : "string"
},
"externalPort" : {
"description" : "External port number of the AP. This is only applicable when the AP is behind a NAT server.",
"type" : "integer"
},
"configState" : {
"description" : "State of the AP configuration.",
"enum" : [ "newConfig", "fwApplied", "fwDownloaded", "fwFailed", "configApplied", "completed", "configFailed" ]
},
"connectionState" : {
"description" : "Connection state of the AP (value: 'Discovery','Connect','Rebooting','Disconnect','Provisioned')",
"type" : "string"
},
"registrationState" : {
"description" : "Registration state of the AP",
"type" : "string"
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"enum" : [ "Locked", "Unlocked" ]
},
"provisionMethod" : {
"description" : "Provisioning method of the AP. Discovered indicates that the AP contacted the controller using discovery and the AP did not have pre-existing record on the controller. Preprovision indicates that the AP was provisioned to the controller before AP made the first contact. Swap indicates that the AP was provisioned to be a replacement of an existing AP.",
"enum" : [ "Discovered", "Preprovision", "Swap" ]
},
"provisionStage" : {
"description" : "Provisioning stage of the AP. This indicates the stage at which the AP is at in the provisioning process. (value: 'Waiting for Registration','Pre-Provision AP Joined','Waiting for Swap In;Waiting for registration','Waiting for Swap In;Swap In AP Joined','Swapped In;Waiting for registration','Swapped In','Waiting for Swap Out','Swapped Out','Waiting for Swap In, the other AP was deleted','Swapped In, the other AP was deleted','Waiting for Swap Out, the other AP was deleted','Swapped Out, the other AP was deleted')",
"type" : "string"
},
"isCriticalAP" : {
"description" : "Indicates critical APs. Critical AP are APs that were tagged by the controller based on predefined rules.",
"type" : "boolean"
},
"approvedTime" : {
"description" : "Timestamp when the AP was approved by the controller",
"type" : "integer"
},
"lastSeenTime" : {
"description" : "Timestamp of the last successful communication with the AP",
"type" : "integer"
},
"uptime" : {
"description" : "Uptime of the AP since it was last rebooted (unit:second)",
"type" : "integer"
},
"clientCount" : {
"description" : "Number of clients on the AP",
"type" : "integer"
},
"managementVlan" : {
"description" : "Management vlan on the AP",
"type" : "integer"
}
}
}
Retrieve Alarm Summary ¶
GET/v6_1/aps/{apMac}/operational/alarmSummary
Use this API command to retrieve the alarm summary of an AP.
200
Body
{
"criticalCount": 3,
"majorCount": 3,
"minorCount": 4,
"warningCount": 0
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"criticalCount": {
"description": "Critical alarm count",
"type": "integer"
},
"majorCount": {
"description": "Major alarm count",
"type": "integer"
},
"minorCount": {
"description": "Minor alarm count",
"type": "integer"
},
"warningCount": {
"description": "Warning alarm count",
"type": "integer"
}
}
}
Retrieve Event Summary ¶
GET/v6_1/aps/{apMac}/operational/eventSummary
Use this API command to retrieve the event summary of an AP.
200
Body
{
"criticalCount": 4,
"majorCount": 2,
"minorCount": 5,
"warningCount": 5,
"informationalCount": 2,
"debugCount": 5
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"criticalCount": {
"description": "Critical event count",
"type": "integer"
},
"majorCount": {
"description": "Major event count",
"type": "integer"
},
"minorCount": {
"description": "Minor event count",
"type": "integer"
},
"warningCount": {
"description": "Warning event count",
"type": "integer"
},
"informationalCount": {
"description": "Informational event count",
"type": "integer"
},
"debugCount": {
"description": "Debug event count",
"type": "integer"
}
}
}
Retrieve Alarm List ¶
GET/v6_1/aps/{apMac}/operational/alarms
Use this API command to retrieve the list of alarms on an AP.
- 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
- severity
string
(optional)filter by severity
- category
string
(optional)filter by category
- code
number
(optional)filter by alarm code
- startTime
string
(optional)filter by trigger time later than startTime (milliseconds in UTC time)
- endTime
string
(optional)filter by trigger time earlier than endTime (milliseconds in UTC time)
- status
string
(optional)filter by alarm status
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "538324f5-f085-4567-ae3f-6b40244d38d6",
"time": 1408715298000,
"code": 302,
"category": "AP Communication",
"type": "AP rebooted by system",
"severity": "Major",
"description": "AP [abcpeng@24:C9:A1:1D:55:A0] rebooted because of [application, wsgclient, reboot due to switch radio band].",
"status": "Outstanding",
"clearedTime": null,
"acknowledgedTime": null
},
{
"id": "5cc35da9-4d3c-4c9a-97e0-303d9b2b1776",
"time": 1408715248732,
"code": 307,
"category": "AP Communication",
"type": "AP heartbeat lost",
"severity": "Informational",
"description": "AP [abcpeng@24:C9:A1:1D:55:A0] heartbeat lost.",
"status": "Cleared",
"clearedTime": 1408715299243,
"acknowledgedTime": null
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total alarm count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more alarms after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first alarm returned from the complete alarm list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the alarm",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"time": {
"description": "Time of the alarm",
"type": "string"
},
"code": {
"description": "Alarm code",
"type": "string"
},
"category": {
"description": "Alarm category",
"type": "string"
},
"type": {
"description": "Alarm type",
"type": "string"
},
"severity": {
"description": "Alarm severity",
"enum": [
"Critical",
"Major",
"Minor",
"Warning",
"Informational"
]
},
"description": {
"description": "Alarm description",
"type": "string"
},
"status": {
"description": "Alarm status",
"enum": [
"Outstanding",
"Acknowledged",
"Cleared"
]
},
"clearedTime": {
"description": "Time that alarm was cleared",
"type": "integer"
},
"acknowledgedTime": {
"description": "Time the alarm was acknowledged",
"type": "integer"
}
}
}
}
}
}
Retrieve Event List ¶
GET/v6_1/aps/{apMac}/operational/events
Use this API command to retrieve the list of events from an AP.
- 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
- severity
string
(optional)filter by severity
- category
string
(optional)filter by category
- code
number
(optional)filter by event code
- startTime
string
(optional)filter by trigger time later than startTime (milliseconds in UTC time)
- endTime
string
(optional)filter by trigger time earlier than endTime (milliseconds in UTC time)
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "7a06627a-f739-4aac-b2a1-5fc6d7bb2767",
"time": 1408648612000,
"code": 110,
"category": "AP Communication",
"type": "AP configuration updated",
"severity": "Informational",
"description": "AP [abcpeng@24:C9:A1:1D:55:A0] updated to configuration [af8d97a0-2967-11e4-91cf-000c29b1347d]."
},
{
"id": "8c5796c1-746c-460b-81f0-f97b8ab2b74f",
"time": 1408648603000,
"code": 109,
"category": "AP Communication",
"type": "Updating AP configuration...",
"severity": "Informational",
"description": "AP [abcpeng@24:C9:A1:1D:55:A0] is being updated to new configuration ID [af8d97a0-2967-11e4-91cf-000c29b1347d]."
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total event count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more events after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first event returned from the complete event list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the event",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"time": {
"description": "Time of the event",
"type": "string"
},
"code": {
"description": "Event code",
"type": "string"
},
"category": {
"description": "Event category",
"type": "string"
},
"type": {
"description": "Event type",
"type": "string"
},
"severity": {
"description": "Event severity",
"enum": [
"Critical",
"Major",
"Minor",
"Warning",
"Informational",
"Debug"
]
},
"description": {
"description": "Event description",
"type": "string"
}
}
}
}
}
}
Retrieve Mesh Neighbor AP List ¶
GET/v6_1/aps/{apMac}/operational/neighbor
Use this API command to retrieve a list of neighbor access points on mesh AP.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"mac": "8C:0C:90:2B:8B:90",
"model": "ZF7372",
"name": "RuckusAP",
"version": "3.1.0.0.157",
"ip": "10.2.6.239",
"externalIp": "10.2.6.239",
"externalPort": "58788",
"connectionState": "Connect",
"channel": "40 (11a/n)",
"signal": "119%",
"zoneName": "neilMeshZone"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total mesh neighbor APs count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Mesh Neighbor APs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Mesh Neighbor AP returned out of the complete Mesh Neighbor AP list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "MAC address of the mesh neighbor AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"name": {
"description": "Name of the mesh neighbor AP",
"type": "string"
},
"zoneName": {
"description": "Name of the zone which the mesh neighbor AP belongs to",
"type": "string"
},
"ip": {
"description": "IP address of the mesh neighbor AP",
"type": "string"
},
"externalIp": {
"description": "External IP of the mesh neighbor AP",
"type": "string"
},
"externalPort": {
"description": "External port of the mesh neighbor AP",
"type": "string"
},
"model": {
"description": "Model of the mesh neighbor AP",
"type": "string"
},
"version": {
"description": "Firmware version of the mesh neighbor AP",
"type": "string"
},
"channel": {
"description": "Channel of the mesh neighbor AP",
"type": "string"
},
"signal": {
"description": "Signal of the mesh neighbor AP",
"type": "string"
},
"connectionState": {
"description": "Connection state of the mesh neighbor AP",
"type": "string"
}
}
}
}
}
}
Retrieve Rogue AP List ¶
GET/v5_0/rogueaps
Use this API command to retrieve a list of rogue access points.
Deprecated : this URI will be deprecated after Version: v5_0, not support. For the alternative URI, please refer to the “QUERY ROGUE AP LIST” section of the category “Query With Filter”.
- 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
- type
string
(optional)Filter rogue ap list by type. Valid values are: (ROGUE, MALICIOUS_AP_SSID_SPOOF, MALICIOUS_AP_MAC_SPOOF, MALICIOUS_AP_SAME_NETWORK, AD_HOC).
- rogueMac
string
(optional)Filter rogue ap list by Rogue MAC.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"apMac": "C4:10:8A:1F:D3:99",
"apName": "apName",
"rogueMac": "8C:0C:90:05:87:B8",
"rogueAPMac": "01:01:03:04:05:10",
"rssi": "10DB",
"encryption": "0",
"radio": "2.4G",
"type": "ROGUE",
"channel": "11",
"ssid": "test",
"timestamp": null,
"id": "C4:10:8A:1F:D3:99_8C:0C:90:05:87:B8"
}
]
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"description" : "Total Rogue APs count",
"type" : "integer"
},
"hasMore" : {
"description" : "Indicator of whether there are more Rogue AP after the current displayed list",
"type" : "boolean"
},
"firstIndex" : {
"description" : "Index of the first Rogue AP returned out of the complete Rogue AP list",
"type" : "integer"
},
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the rogue AP",
"type" : "string"
},
"apMac" : {
"description" : "AP MAC of the rogue AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"apName" : {
"description" : "Name of the rogue AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"rogueMac" : {
"description" : "Rogue MAC of the rogue AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"rogueAPMac" : {
"description" : "Rogue AP MAC of the rogue AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"rssi" : {
"description" : "RSSI of the rogue AP",
"type" : "string"
},
"encryption" : {
"description" : "Encryption of the rogue AP",
"type" : "string"
},
"radio" : {
"description" : "Radio of the rogue AP",
"type" : "string"
},
"type" : {
"description" : "Type of the rogue AP",
"type" : "string"
},
"channel" : {
"description" : "Channel of the rogue AP",
"type" : "string"
},
"ssid" : {
"description" : "SSID of the rogue AP",
"type" : "string"
},
"timestamp" : {
"description" : "Timestamp of the rogue AP",
"type" : "string"
}
}
}
}
}
}
WLAN Group ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/wlangroups
Use this API command to retrieve the list of WLAN groups within a zone.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "wlanGroupUUID",
"name": "wlanGroupName",
"description": "wlanGroupDescription",
"members": [
{
"id": "wlanID",
"accessVlan": 1,
"nasId": "nasId",
"vlanPooling": null
}
]
},
{
"id": "wlanGroupUUID2",
"zoneId": "zoneUUID",
"name": "wlanGroupName2",
"description": "wlanGroupDescription2",
"members": [
{
"id": "wlanID2",
"accessVlan": 1,
"nasId": "nasId",
"vlanPooling": null
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the WLAN group belongs",
"type": "string"
},
"name": {
"description": "Name of the WLAN group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN group",
"type": [
"string",
"null"
],
"maxLength": 64
},
"members": {
"description": "Members of the WLAN group",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN",
"type": "string"
},
"accessVlan": {
"description": "Access VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"nasId": {
"description": "NAS-ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"id"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"name"
]
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/wlangroups/{id}
Use this API command to retrieve the WLAN group.
200
Body
{
"id": "wlanGroupUUID2",
"zoneId": "zoneUUID",
"name": "wlanGroupName2",
"description": "wlanGroupDescription2",
"members": [
{
"id": "wlanID2",
"accessVlan": 1,
"nasId": "nasId",
"vlanPooling": null
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the WLAN group belongs",
"type": "string"
},
"name": {
"description": "Name of the WLAN group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN group",
"type": [
"string",
"null"
],
"maxLength": 64
},
"members": {
"description": "Members of the WLAN group",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN",
"type": "string"
},
"accessVlan": {
"description": "Access VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"nasId": {
"description": "NAS-ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"id"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"name"
]
}
Create ¶
POST/v6_1/rkszones/{zoneId}/wlangroups
Use this API command to create a new WLAN group.
Body
{
"name": "wlanGroupName",
"description": "wlanGroupDescription"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the WLAN group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN group",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"name"
]
}
201
Body
{
"id": "wlanGroupUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/wlangroups/{id}
Use this API command to modify the basic information of a WLAN group.
Body
{
"name": "wlanGroupNameModified",
"description": "wlanGroupDescriptionModified",
"members": [
{
"id": "wlanID",
"accessVlan": 0,
"nasId": "nasId",
"vlanPooling": {
"id": "a61997e0-699b-11e4-b9bb-08002716c79f",
"name": "zoneVlanPooling"
}
},
{
"id": "wlanID2",
"accessVlan": 1,
"nasId": "nasId",
"vlanPooling": null
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the WLAN group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN group",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
204
Add Member ¶
POST/v6_1/rkszones/{zoneId}/wlangroups/{id}/members
Use this API command to add a member to a WLAN group.
Body
{
"id": "wlanID",
"accessVlan": 1
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN",
"type": "string"
},
"accessVlan": {
"description": "Access VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"nasId": {
"description": "NAS-ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"id"
]
}
201
Modify Member ¶
PATCH/v6_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}
Use this API command to modify a member of a WLAN group.
Body
{
"accessVlan": 23,
"nasId": "nasId",
"vlanPooling": {
"id": "a61997e0-699b-11e4-b9bb-08002716c79f",
"name": "zoneVlanPooling"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"accessVlan": {
"description": "Access VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"nasId": {
"description": "NAS-ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
}
}
204
Modify Member VLAN Pooling ¶
PATCH/v6_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanPooling
Use this API command to modify a member’s VLAN pooling of a WLAN group.
Body
{
"id": "a61997e0-699b-11e4-b9bb-08002716c79f",
"name": "zoneVlanPooling"
}
Schema
{
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable Member VLAN Override ¶
DELETE/v6_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanOverride
Use this API command to disable a member VLAN override of a WLAN group.
204
Disable Member NAS Override ¶
DELETE/v6_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/nasId
Use this API command to disable a member NAS-ID override of a WLAN group.
204
WLAN ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/wlans
Use this API command to retrieve a list of WLANs within a zone.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "1028",
"mvnoId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"zoneId": "11111111-2222-3333-4444-555555555555",
"name": "wlan2",
"ssid": "wlan2"
},
{
"id": "1027",
"mvnoId": "bbbbbbbb-bbbb-cccc-dddd-eeeeeeeeeeee",
"zoneId": "22222222-2222-3333-4444-555555555555",
"name": "wlan1",
"ssid": "wlan1"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"zoneId": {
"description": "Zone ID",
"type": "string"
},
"name": {
"description": "Name of the WLAN",
"type": "string"
},
"ssid": {
"description": "SSID of the WLAN",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/wlans/{id}
Use this API command to retrieve a WLAN.
200
Body
{
"id": "1027",
"zoneId": "21a18b1c-e260-48c8-866c-69e66c81368e",
"name": "wlan1",
"ssid": "wlan1",
"hessid": "BSSID",
"description": "",
"type": "Standard_Open",
"encryption": {
"method": "None"
},
"macAuth": null,
"authServiceOrProfile": null,
"operatorRealm": null,
"accountingServiceOrProfile": {
"id": "",
"name": null,
"throughController": false,
"interimUpdateMin": null,
"accountingTTGSessionEnabled": false,
"accountingDelayEnabled": null
},
"accessTunnelType": "APLBO",
"coreTunnelProfile": null,
"portalServiceProfile": null,
"hotspot20Profile": null,
"defaultUserTrafficProfile": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "Factory Default"
},
"l2ACL": null,
"devicePolicy": null,
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"vlan": {
"accessVlan": null,
"aaaVlanOverride": false,
"coreQinQEnabled": false,
"coreSVlan": null,
"vlanpooling": {
"id": "0b8d4e50-167a-11e6-97a5-56847afe9799",
"name": "X27s"
}
},
"schedule": {
"id": null,
"name": null,
"type": "AlwaysOn"
},
"radiusOptions": {
"nasIdType": "WLAN_BSSID",
"customizedNasId": null,
"nasRequestTimeoutSec": 3,
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1",
"singleSessionIdAcctEnabled": false
},
"advancedOptions": {
"uplinkEnabled": false,
"downlinkEnabled": false,
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": false,
"dgafEnabled": null,
"maxClientsPerRadio": 100,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": false,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientIdleTimeoutSec": 120,
"clientFingerprintingEnabled": false,
"ofdmOnlyEnabled": false,
"hs20Onboarding": false,
"avcEnabled": false,
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"bandBalancing": "UseZoneSetting",
"dtimInterval": 1,
"directedThreshold": 5,
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dpsk": {
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"bssid": [
"E0:10:7F:28:C9:D8",
"E0:10:7F:28:C9:DC"
]
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone to which the WLAN belongs",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN",
"type" : "string"
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string"
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : "string"
},
"type" : {
"description" : "Type of the WLAN",
"enum" : [ "Standard_Open", "Standard_8021X", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20", "Hotspot20_Open", "Hotspot20_OSEN" ]
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Autentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"macAuth" : {
"description" : "MAC authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to data plane, SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"bssid" : {
"description" : "BSSID of the WLAN",
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
Create - Standard Open ¶
POST/v6_1/rkszones/{zoneId}/wlans
Use this API command to create a new standard, open and non-tunneled basic WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": false,
"encryption": {
"method": "None"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - 802.1X - Deprecated ¶
POST/v5_1/rkszones/{zoneId}/wlans/standard80211
Use this API command to create a new standard, 802.1X and non-tunneled WLAN.
Deprecated : this URI will be deprecated after Version: v5_1, not support.For the alternative URI, please refer to the “Create - 802.1X”
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": ""
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - 802.1X ¶
POST/v6_1/rkszones/{zoneId}/wlans/standard8021X
Use this API command to create a new standard, 802.1X and non-tunneled WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": ""
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - MAC Auth ¶
POST/v6_1/rkszones/{zoneId}/wlans/standardmac
Use this API command to create a new standard, MAC auth and non-tunneled WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": false,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - 802.1X with MAC Address ¶
POST/v6_1/rkszones/{zoneId}/wlans/standard8021Xmac
Use this API command to create a new standard, 802.1X with MAC address and non-tunneled WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": false,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": ""
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Hotspot ¶
POST/v6_1/rkszones/{zoneId}/wlans/wispr
Use this API command to create new hotspot (WISPr) WLAN.
Body
‧ Sample : Create a Hotspot (WISPr) WLAN with default configurations
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName",
"authenticationOption" : null
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
},
"accessTunnelType" : "RuckusGRE",
"coreTunnelProfile" : {
"type" : "Bridge",
"id" : "forwardingUUID",
"name" : "forwardingName"
},
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES",
"passphrase" : "password",
"mfp" : "disabled",
"support80211rEnabled" : true,
"mobilityDomainId" : 3
},
"operatorRealm" : "operator realm",
"defaultUserTrafficProfile" : {
"id" : "userTrafficUUID",
"name" : "userTrafficName"
},
"schedule" : {
"type" : "Customized",
"id" : "ServiceUUID",
"name" : "ServiceName"
},
"vlan" : {
"accessVlan" : 23,
"coreQinQEnabled" : false,
"coreSVlan" : 1,
"vlanPooling" : null
},
"l2ACL" : {
"id" : "l2ACLUUID",
"name" : "l2ACLName"
},
"devicePolicy" : {
"id" : "devicePolicyUUID",
"name" : "devicePolicyName"
},
"radiusOptions" : {
"nasIdType" : "Customized",
"customizedNasId" : "nasId",
"nasRequestTimeoutSec" : 12,
"nasMaxRetry" : 3,
"nasReconnectPrimaryMin" : 30,
"calledStaIdType" : "WLAN_BSSID",
"nasIpType" : "disabled",
"nasIpUserDefined" : "192.168.1.1"
},
"advancedOptions" : {
"clientIsolationEnabled" : true,
"clientIsolationWhitelist" : {
"id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
"name" : "myWhitelist"
},
"priority" : "High",
"hideSsidEnabled" : true,
"maxClientsPerRadio" : 12,
"clientIdleTimeoutSec" : 60,
"clientLoadBalancingEnabled" : true,
"proxyARPEnabled" : true,
"support80211dEnabled" : false,
"support80211kEnabled" : true,
"forceClientDHCPTimeoutSec" : 5,
"dhcpOption82Enabled" : true,
"dhcp82Format" : "RUCKUS_DEFAULT",
"unauthClientStatsEnabled" : false,
"clientFingerprintingEnabled" : true,
"ofdmOnlyEnabled" : false,
"bandBalancing" : "UseZoneSetting",
"bssMinRateMbps" : "Disable",
"mgmtTxRateMbps" : "2 mbps",
"avcEnabled" : true,
"uplinkEnabled" : true,
"uplinkRate" : 100,
"downlinkEnabled" : true,
"downlinkRate" : 200,
"ratePerSTAUplink" : "650mbps",
"ratePerSTADownlink" : "1mbps"
},
"diffServProfile" : {
"id" : "diffServId",
"name" : "diffServName"
},
"qosMaps" : [ {
"enable" : true,
"priority" : 0,
"low" : 0,
"high" : 7,
"excepts" : null
}, {
"enable" : true,
"priority" : 1,
"low" : 8,
"high" : 15,
"excepts" : null
}, {
"enable" : true,
"priority" : 2,
"low" : 16,
"high" : 23,
"excepts" : null
}, {
"enable" : true,
"priority" : 3,
"low" : 0,
"high" : 32,
"excepts" : [ 43, 45, 60 ]
}, {
"enable" : true,
"priority" : 4,
"low" : 32,
"high" : 39,
"excepts" : null
}, {
"enable" : true,
"priority" : 5,
"low" : 40,
"high" : 47,
"excepts" : null
}, {
"enable" : true,
"priority" : 6,
"low" : 48,
"high" : 55,
"excepts" : [ 46 ]
}, {
"enable" : true,
"priority" : 7,
"low" : 56,
"high" : 63,
"excepts" : null
} ],
"dnsServerProfile" : {
"id" : "DNS server profile UUID",
"name" : "DNS server profile name"
},
"dpsk" : {
"dpskEnabled" : false,
"length" : 8,
"dpskType" : "Secure",
"expiration" : "OneDay",
"dpskFromType" : "FirstUse"
},
"externalDpsk" : {
"enabled" : true,
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES"
},
"authService" : {
"id" : "authServiceUUID"
}
}
}
‧ Sample : Create a Hotspot (WISPr) WLAN allows Hotspot 2.0 Onboarding
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
},
"advancedOptions" : {
"hs20Onboarding" : true
}
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : true,
"authenticationOption" : "Local DB"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Hotspot + MAC bypass ¶
POST/v6_1/rkszones/{zoneId}/wlans/wisprmac
Use this API command to create a new hotspot (WISPr) with MAC bypass WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": false,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Hotspot + 802.1X ¶
POST/v6_1/rkszones/{zoneId}/wlans/wispr8021X
Use this API command to create a new hotspot (WISPr) with 802.1X WLAN.
Body
{
"name": "wispr8021XWlan",
"ssid": "wispr8021XWlan",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": true,
"realmBasedAuth": true,
"id": "realmBasedProfileUUID",
"name": "realmBasedProfileName",
"authenticationOption": null
},
"accountingServiceOrProfile": {
"accountingDelayEnabled": false,
"interimUpdateMin": 10,
"throughController": true,
"realmBasedAcct": true,
"name": "realmBasedProfileName"
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": ""
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Guest Access ¶
POST/v6_1/rkszones/{zoneId}/wlans/guest
Use this API command to create a new guest access WLAN.
Body
‧ Sample : Create a Guest WLAN with default configurations
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName",
"authenticationOption" : null
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
},
"accessTunnelType" : "RuckusGRE",
"coreTunnelProfile" : {
"type" : "Bridge",
"id" : "forwardingUUID",
"name" : "forwardingName"
},
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES",
"passphrase" : "password",
"mfp" : "disabled",
"support80211rEnabled" : true,
"mobilityDomainId" : 3
},
"operatorRealm" : "operator realm",
"defaultUserTrafficProfile" : {
"id" : "userTrafficUUID",
"name" : "userTrafficName"
},
"schedule" : {
"type" : "Customized",
"id" : "ServiceUUID",
"name" : "ServiceName"
},
"vlan" : {
"accessVlan" : 23,
"coreQinQEnabled" : false,
"coreSVlan" : 1,
"vlanPooling" : null
},
"l2ACL" : {
"id" : "l2ACLUUID",
"name" : "l2ACLName"
},
"radiusOptions" : {
"nasIdType" : "Customized",
"customizedNasId" : "nasId",
"nasRequestTimeoutSec" : 12,
"nasMaxRetry" : 3,
"nasReconnectPrimaryMin" : 30,
"calledStaIdType" : "WLAN_BSSID",
"nasIpType" : "disabled",
"nasIpUserDefined" : "192.168.1.1"
},
"advancedOptions" : {
"clientIsolationEnabled" : true,
"clientIsolationWhitelist" : {
"id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
"name" : "myWhitelist"
},
"priority" : "High",
"hideSsidEnabled" : true,
"maxClientsPerRadio" : 12,
"clientIdleTimeoutSec" : 60,
"clientLoadBalancingEnabled" : true,
"proxyARPEnabled" : true,
"support80211dEnabled" : false,
"support80211kEnabled" : true,
"forceClientDHCPTimeoutSec" : 5,
"dhcpOption82Enabled" : true,
"dhcp82Format" : "RUCKUS_DEFAULT",
"unauthClientStatsEnabled" : false,
"clientFingerprintingEnabled" : true,
"ofdmOnlyEnabled" : false,
"bandBalancing" : "UseZoneSetting",
"bssMinRateMbps" : "Disable",
"mgmtTxRateMbps" : "2 mbps",
"avcEnabled" : true,
"uplinkEnabled" : true,
"uplinkRate" : 100,
"downlinkEnabled" : true,
"downlinkRate" : 200,
"ratePerSTAUplink" : "650mbps",
"ratePerSTADownlink" : "1mbps",
"urlFilteringPolicyEnabled" : true,
"urlFilteringPolicyId" : "eabd4fa0-5015-11e7-84d0-525400a0e6c5"
},
"diffServProfile" : {
"id" : "diffServId",
"name" : "diffServName"
},
"qosMaps" : [ {
"enable" : true,
"priority" : 0,
"low" : 0,
"high" : 7,
"excepts" : null
}, {
"enable" : true,
"priority" : 1,
"low" : 8,
"high" : 15,
"excepts" : null
}, {
"enable" : true,
"priority" : 2,
"low" : 16,
"high" : 23,
"excepts" : null
}, {
"enable" : true,
"priority" : 3,
"low" : 0,
"high" : 32,
"excepts" : [ 43, 45, 60 ]
}, {
"enable" : true,
"priority" : 4,
"low" : 32,
"high" : 39,
"excepts" : null
}, {
"enable" : true,
"priority" : 5,
"low" : 40,
"high" : 47,
"excepts" : null
}, {
"enable" : true,
"priority" : 6,
"low" : 48,
"high" : 55,
"excepts" : [ 46 ]
}, {
"enable" : true,
"priority" : 7,
"low" : 56,
"high" : 63,
"excepts" : null
} ],
"dnsServerProfile" : {
"id" : "DNS server profile UUID",
"name" : "DNS server profile name"
},
"dpsk" : {
"dpskEnabled" : false,
"length" : 8,
"dpskType" : "Secure",
"expiration" : "OneDay",
"dpskFromType" : "FirstUse"
},
"externalDpsk" : {
"enabled" : true,
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES"
},
"authService" : {
"id" : "authServiceUUID"
}
}
}
‧ Sample : Create a Guest WLAN with authenticationOption configurations
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : true,
"authenticationOption" : "Guest"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Web Auth ¶
POST/v6_1/rkszones/{zoneId}/wlans/webauth
Use this API command to creates new web authentication WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Hotspot 2.0 ¶
POST/v6_1/rkszones/{zoneId}/wlans/hotspot20
Use this API command to create a new Hotspot 2.0 access WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"hotspot20Profile": {
"id": "hotspot20ServiceUUID",
"name": "hotspot20ServiceName"
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. The ID or name of the Hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "hotspot20Profile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Hotspot 2.0 Open ¶
POST/v6_1/rkszones/{zoneId}/wlans/hotspot20open
Use this API command to create a new Hotspot 2.0 Onboarding WLAN with Authentication Method as ‘Open’.
Body
{
"name": "api-test-wlanhs20open",
"ssid": "api-test-wlanhs20open",
"description": "wlanDescription"
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Hotspot 2.0 OSEN ¶
POST/v6_1/rkszones/{zoneId}/wlans/hotspot20osen
Use this API command to create a new Hotspot 2.0 Onboarding WLAN with Authentication Method as ‘802.1X’.
Body
{
"name": "api-test-wlanhs20osen",
"ssid": "api-test-wlanhs20osen",
"description": "wlanDescription",
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"mfp": "disabled",
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": ""
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create - Wechat ¶
POST/v6_1/rkszones/{zoneId}/wlans/wechat
Use this API command to create a new wechat WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "None"
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Wechat portal service of the WLAN. The ID or name of the wechat portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "name", "ssid", "portalServiceProfile" ]
}
201
Body
{
"id": "wlanID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify Entire ¶
PUT/v6_1/rkszones/{zoneId}/wlans/{id}
Use this API command to modify entire information of a WLAN.
Body
{
"name": "wlanOpen",
"ssid": "wlanSSID",
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"name": "Factory Default"
},
"advancedOptions": {
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"ratePerSTADownlink": "1mbps",
"flowLogEnabled": true,
"hdOverheadOptimizeEnable": false,
"transientClientMgmtEnable": false,
"directedThreshold": 5,
"hs20Onboarding": false,
"dtimInterval": 1
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID"
},
"schedule": {
"type": "AlwaysOn"
},
"encryption": {
"method": "None"
},
"vlan": {
"accessVlan": 23
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
}
204
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}
Use this API command to modify the basic information of a WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"accessTunnelType": "RuckusGRE",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"authServiceOrProfile": {
"throughController": true,
"id": "authServiceUUID",
"locationDeliveryEnabled": true,
"authenticationOption": null
},
"operatorRealm": "operator realm",
"accountingServiceOrProfile": {
"throughController": false,
"id": "accountingServiceUUID",
"name": "accountingServiceName",
"interimUpdateMin": 10,
"accountingDelayEnabled": false,
"accountingTTGSessionEnabled": false
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"hotspot20Profile": {
"id": "hotspot20ServiceUUID",
"name": "hotspot20ServiceName"
},
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": null,
"vlanpooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1",
"singleSessionIdAcctEnabled": false
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 12,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"hs20Onboarding": false,
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 1800,
"downlinkEnabled": true,
"downlinkRate": 2000,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"dtimInterval": 1,
"directedThreshold": 5,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": ""
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"description" : "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"description" : "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"default" : "Disable",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"default" : "1 mbps",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : true
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type" : "boolean",
"default" : false
},
"transientClientMgmtEnable" : {
"description" : "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"description" : "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"joinIgnoreTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
}
204
Modify Authentication ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/authServiceOrProfile
Use this API command to modify the authentication method of a WLAN.
Body
{
"throughController": true,
"id": "authServiceUUID",
"locationDeliveryEnabled": true,
"authenticationOption": null
}
Schema
{
"description": "Authentication of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"throughController": {
"description": "Indicates whether authentication messages were sent through the controller or not",
"type": "boolean"
},
"realmBasedAuth": {
"description": "wlan.wlanAuthentication.properties.realmBasedAuth.description",
"type": "boolean"
},
"id": {
"description": "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type": "string"
},
"name": {
"description": "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type": "string"
},
"authenticationOption": {
"description": "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"enum": [
"Local DB",
"Guest",
"Always Accept",
null
]
},
"locationDeliveryEnabled": {
"description": "RFC5580 location delivery support",
"type": "boolean"
}
}
}
204
Modify MAC Auth ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/macAuth
Use this API command to modify the MAC authentication settings of a WLAN. macAuthMacFormat : Open (aabbccddeeff), 802.1X (AA-BB-CC-DD-EE-FF), UpperColon (AA:BB:CC:DD:EE:FF), Upper (AABBCCDDEEFF), LowerDash (aa-bb-cc-dd-ee-ff) and LowerColon (aa:bb:cc:dd:ee:ff).
Body
{
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
}
Schema
{
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
}
204
Modify Accounting ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile
Use this API command to modify the accounting settings of a WLAN.
Body
{
"throughController": false,
"id": "accountingServiceUUID",
"name": "accountingServiceName",
"interimUpdateMin": 10,
"accountingDelayEnabled": false,
"accountingTTGSessionEnabled": false
}
Schema
{
"description": "Accounting of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"throughController": {
"description": "Indicates whether accounting messages were sent through the controller",
"type": "boolean"
},
"realmBasedAcct": {
"description": "wlan.wlanAccounting.properties.realmBasedAcct.description",
"type": "boolean"
},
"id": {
"description": "Accounting service or profile ID. At least one ID or name is required in the request.",
"type": "string"
},
"name": {
"description": "Accounting service or profile name. At least one ID or name is required in the request.",
"type": "string"
},
"interimUpdateMin": {
"description": "Interval (in minutes) for sending interim updates",
"type": "integer",
"minimum": 0,
"maximum": 1440
},
"accountingDelayEnabled": {
"description": "Indicates whether accounting delay time is enabled",
"type": "boolean"
},
"accountingTTGSessionEnabled": {
"description": "Indicates whether accounting for TTG sessions is to enabled",
"type": "boolean"
}
}
}
204
Disable Accounting ¶
DELETE/v6_1/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile
Use this API command to disable the accounting of a WLAN.
204
Modify Encryption ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/encryption
Use this API command to modify the encryption settings of a WLAN.
Body
{
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
}
Schema
{
"description": "Encryption of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"method": {
"description": "Encryption method",
"enum": [
"WPA2",
"WPA_Mixed",
"WEP_64",
"WEP_128",
"None"
]
},
"algorithm": {
"description": "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum": [
"AES",
"TKIP_AES"
]
},
"passphrase": {
"description": "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type": "string"
},
"mfp": {
"description": "Management frame protection. This only applies to WPA2 + AES",
"enum": [
"disabled",
"capable",
"required"
]
},
"keyIndex": {
"description": "Key index. This only applies to WEP64 and WEP128.",
"type": "integer"
},
"keyInHex": {
"description": "Key in hex format. This only applies to WEP64 and WEP128.",
"type": "string"
},
"support80211rEnabled": {
"description": "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type": "boolean"
},
"mobilityDomainId": {
"description": "mobility Domain Id.",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
},
"required": [
"method"
]
}
204
Modify Core Tunnel ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/coreTunnelProfile
Use this API command to modify the core tunnel configuration of a WLAN.
Body
{
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
}
Schema
{
"description": "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Tunnel type",
"enum": [
"Bridge",
"L2oGRE",
"TTG_PDG",
"Mixed"
]
},
"id": {
"description": "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type": "string"
},
"name": {
"description": "Name of the forwarding profile. At least one ID or name is required in the request.",
"type": "string"
},
"operatorRealm": {
"description": "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"type"
]
}
204
Modify Portal Profile ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/portalServiceProfile
Use this API command to modify the portal configuration of a WLAN.
Body
{
"id": "portalServiceUUID",
"name": "portalServiceName"
}
Schema
{
"description": "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Modify Hotspot20 Profile ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/hotspot20Profile
Use this API command to modify the Hotspot 2.0 profile configuration of a WLAN.
Body
{
"id": "hotspot20ServiceUUID",
"name": "hotspot20ServiceName"
}
Schema
{
"description": "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Modify User Traffic Profile ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/defaultUserTrafficProfile
Use this API command to modify the user traffic profile configuration of a WLAN.
Body
{
"id": "userTrafficUUID",
"name": "userTrafficName"
}
Schema
{
"description": "User traffic profile of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Modify Schedule ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/schedule
Use this API command to modify the schedule configuration of a WLAN.
Body
{
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
}
Schema
{
"description": "Schedule of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Type of WLAN schedule",
"enum": [
"AlwaysOn",
"AlwaysOff",
"Customized"
]
},
"id": {
"description": "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type": "string"
},
"name": {
"description": "Name of the schedule profile. At least one ID or name is required in the request.",
"type": "string"
}
},
"required": [
"type"
]
}
204
Modify VLAN ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/vlan
Use this API command to modify the VLAN configuration of a WLAN.
Body
{
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": null,
"vlanpooling": null
}
Schema
{
"description": "VLAN (access and/or core) of the WLAN.",
"type": "object",
"additionalProperties": false,
"properties": {
"accessVlan": {
"description": "Access VLAN ID",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"aaaVlanOverride": {
"description": "Indicates whether the AAA VLAN settings can be overriden or not",
"type": "boolean"
},
"coreQinQEnabled": {
"description": "Indicates whether Q-in-Q is allowed at the core network or not",
"type": "boolean"
},
"coreSVlan": {
"description": "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
204
Modify Layer 2 ACL ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/l2ACL
Use this API command to modify the layer 2 access control list (ACL) configuration of a WLAN.
Body
{
"id": "l2ACLUUID",
"name": "l2ACLName"
}
Schema
{
"description": "Layer 2 ACL of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable Layer 2 ACL ¶
DELETE/v6_1/rkszones/{zoneId}/wlans/{id}/l2ACL
Use this API command to disable the layer 2 access control list (ACL) configuration of a WLAN.
204
Modify Device Policy ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/devicePolicy
Use this API command to modify the device policy of a WLAN.
Body
{
"id": "devicePolicyUUID",
"name": "devicePolicyName"
}
Schema
{
"description": "Device policy of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable Device Policy ¶
DELETE/v6_1/rkszones/{zoneId}/wlans/{id}/devicePolicy
Use this API command to disable the device policy of a WLAN.
204
Modify RADIUS Options ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/radiusOptions
Use this API command to modify the RADIUS settings of a WLAN.
Body
{
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1",
"singleSessionIdAcctEnabled": false
}
Schema
{
"description": "RADIUS options of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"nasIdType": {
"description": "NAS ID type",
"enum": [
"WLAN_BSSID",
"AP_MAC",
"Customized"
],
"default": "WLAN_BSSID"
},
"customizedNasId": {
"description": "User defined NAS ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec": {
"description": "NAS request timeout in seconds",
"type": "integer",
"default": 3,
"minimum": 2,
"maximum": 20
},
"nasMaxRetry": {
"description": "NAS request maximum retry",
"type": "integer",
"default": 2,
"minimum": 2,
"maximum": 10
},
"nasReconnectPrimaryMin": {
"description": "NAS reconnect primary time in minutes",
"type": "integer",
"default": 5,
"minimum": 1,
"maximum": 60
},
"calledStaIdType": {
"description": "Called station ID type",
"enum": [
"WLAN_BSSID",
"AP_MAC",
"NONE"
],
"default": "WLAN_BSSID"
},
"nasIpType": {
"description": "NAS IP type",
"enum": [
"disabled",
"control",
"management",
"userDefined"
],
"default": "disabled"
},
"nasIpUserDefined": {
"description": "User-defined NAS IP",
"type": "string",
"maxLength": 45
},
"singleSessionIdAcctEnabled": {
"description": "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type": "boolean",
"default": false
}
}
}
204
Modify Advanced Options ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/advancedOptions
Use this API command to modify the advanced settings of a WLAN.
Body
{
"clientIsolationEnabled": true,
"clientIsolationWhitelist": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 12,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"hs20Onboarding": false,
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 1800,
"downlinkEnabled": true,
"downlinkRate": 2000,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"dtimInterval": 1,
"directedThreshold": 5,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": ""
}
Schema
{
"description": "Advanced settings for the WLAN.",
"type": "object",
"additionalProperties": false,
"properties": {
"clientIsolationEnabled": {
"description": "Indicates whether wireless client isolation is enabled or disabled",
"type": "boolean",
"default": true
},
"clientIsolationWhitelist": {
"description": "Indicates wireless client isolation whitelist",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"priority": {
"description": "Priority of the WLAN",
"enum": [
"High",
"Low"
],
"default": "High"
},
"hideSsidEnabled": {
"description": "Indicates whether the SSID is hidden or broadcast",
"type": "boolean",
"default": false
},
"hs20Onboarding": {
"description": "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type": "boolean",
"default": false
},
"maxClientsPerRadio": {
"description": "Maximum number of clients per radio",
"type": "integer",
"default": 100,
"minimum": 1,
"maximum": 512
},
"clientIdleTimeoutSec": {
"description": "Client idle timeout in seconds",
"type": "integer",
"minimum": 60,
"maximum": 1000,
"default": 120
},
"dgafEnabled": {
"description": "Indicates whether dgaf is enabled or disabled",
"type": "boolean"
},
"clientLoadBalancingEnabled": {
"description": "Indicates whether Client Load Balancing is enabled or disabled",
"type": "boolean"
},
"proxyARPEnabled": {
"description": "Indicates whether proxy ARP is enabled or disabled",
"type": "boolean",
"default": false
},
"support80211dEnabled": {
"description": "Indicates whether support for 802.11d is enabled or disabled",
"type": "boolean",
"default": true
},
"support80211kEnabled": {
"description": "Indicates whether support for 802.11k is enabled or disabled",
"type": "boolean",
"default": true
},
"forceClientDHCPTimeoutSec": {
"description": "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"enum": [
0,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
],
"default": 0
},
"dhcpOption82Enabled": {
"description": "Indicates whether DCHP Option 82 is enabled or disabled",
"type": "boolean",
"default": false
},
"dhcp82Format": {
"description": "DHCP Option 82 format",
"enum": [
"RUCKUS_DEFAULT",
"SOFTGRE_CUSTOMIZED"
]
},
"unauthClientStatsEnabled": {
"description": "Indicates whether to send statistics of unauthorized clients or not",
"type": "boolean",
"default": true
},
"clientFingerprintingEnabled": {
"description": "Indicates whether client fingerprinting is enabled or disabled",
"type": "boolean",
"default": false
},
"ofdmOnlyEnabled": {
"description": "Indicates whether OFDM only is enabled or disabled",
"type": "boolean",
"default": false
},
"bandBalancing": {
"description": "Indicates whether band balancing is enabled or disabled",
"enum": [
"Disabled",
"UseZoneSetting"
],
"default": "UseZoneSetting"
},
"bssMinRateMbps": {
"description": "BSS minimum rate (mbps)",
"default": "Disable",
"enum": [
"Disable",
"1 mbps",
"2 mbps",
"5.5 mbps",
"12 mbps",
"24 mbps"
]
},
"mgmtTxRateMbps": {
"description": "Management TX rate (mbps)",
"default": "1 mbps",
"enum": [
"1 mbps",
"2 mbps",
"5.5 mbps",
"6 mbps",
"9 mbps",
"11 mbps",
"12 mbps",
"18 mbps",
"24 mbps",
"36 mbps",
"48 mbps",
"54 mbps"
]
},
"pmkCachingEnabled": {
"description": "Indicator of whether PKM caching support is enabled or disabled",
"type": "boolean",
"default": true
},
"okcEnabled": {
"description": "Indicator of whether OKC support is enabled or disabled",
"type": "boolean",
"default": true
},
"avcEnabled": {
"description": "Indicator of whether ARC support is enabled or disabled",
"type": "boolean",
"default": false
},
"urlFilteringPolicyEnabled": {
"description": "Indicator of whether URL Filtering is enabled or disabled",
"type": "boolean",
"default": false
},
"urlFilteringPolicyId": {
"description": "The URL Filtering policy ID.",
"type": "string"
},
"uplinkEnabled": {
"description": "SSID Rate Limiting uplink enabled.",
"type": "boolean",
"default": false
},
"uplinkRate": {
"description": "SSID Rate Limiting uplink.",
"type": "number"
},
"downlinkEnabled": {
"description": "SSID Rate Limiting downlink enabled.",
"type": "boolean",
"default": false
},
"downlinkRate": {
"description": "SSID Rate Limiting downlink.",
"type": "number"
},
"ratePerSTAUplink": {
"description": "UE Rate Limiting uplink.",
"type": "string"
},
"ratePerSTADownlink": {
"description": "UE Rate Limiting downlink.",
"type": "string"
},
"dtimInterval": {
"description": "DTIM Interval",
"type": "integer",
"minimum": 1,
"maximum": 255,
"default": 1
},
"directedThreshold": {
"description": "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type": "integer",
"minimum": 0,
"maximum": 128,
"default": 5
},
"flowLogEnabled": {
"description": "Flow log enabled.",
"type": "boolean"
},
"hdOverheadOptimizeEnable": {
"description": "wlan.wlanAdvanced.properties.hdOverheadOptimizeEnable.description",
"type": "boolean",
"default": false
},
"transientClientMgmtEnable": {
"description": "wlan.wlanAdvanced.properties.transientClientMgmtEnable.description",
"type": "boolean",
"default": false
},
"probeRssiThr": {
"description": "wlan.wlanAdvanced.properties.probeRssiThr.description",
"type": "integer",
"minimum": -90,
"maximum": -60,
"default": -85
},
"joinIgnoreTimeout": {
"description": "wlan.wlanAdvanced.properties.joinIgnoreTimeout.description",
"type": "integer",
"minimum": 1,
"maximum": 60,
"default": 30
},
"joinAcceptTimeout": {
"description": "wlan.wlanAdvanced.properties.joinAcceptTimeout.description",
"type": "integer",
"minimum": 1,
"maximum": 300,
"default": 300
},
"joinIgnoreThr": {
"description": "wlan.wlanAdvanced.properties.joinIgnoreThr.description",
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 10
}
}
}
204
Modify DiffServ Profile ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/diffServProfile
Use this API command to modify the DiffServ profile of a WLAN.
Body
{
"id": "diffServId",
"name": "diffServName"
}
Schema
{
"description": "DiffServ profile of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable DiffServ Profile ¶
DELETE/v6_1/rkszones/{zoneId}/wlans/{id}/diffServProfile
Use this API command to disable the DiffServ profile of a WLAN.
204
Enable Qos Map Set ¶
POST/v6_1/rkszones/{zoneId}/wlans/{id}/qosMaps
Use this API command to enable Qos Map Set of a WLAN.
201
Modify Qos Map Set ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/qosMaps
Use this API command to modify Qos Map Set of a WLAN.
Body
[
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
]
Schema
{
"description": "Qos map set of the WLAN.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"enable": {
"description": "Enabled or disabled",
"type": "boolean"
},
"priority": {
"description": "Priority",
"type": "integer"
},
"low": {
"description": "DSCP range - low",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 255
},
"high": {
"description": "DSCP range - high",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 255
},
"excepts": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"minimum": 0,
"maximum": 63
}
}
},
"required": [
"enable",
"priority"
]
}
}
204
Disable Qos Map Set ¶
DELETE/v6_1/rkszones/{zoneId}/wlans/{id}/qosMaps
Use this API command to disable Qos Map Set of a WLAN.
204
Modify DNS server profile ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/dnsServerProfile
Use this API command to modify DNS server profile of a WLAN.
Body
{
"id": "DNS server profile UUID",
"name": "DNS server profile name"
}
Schema
{
"description": "DNS server profile of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable DNS server profile ¶
DELETE/v6_1/rkszones/{zoneId}/wlans/{id}/dnsServerProfile
Use this API command to disable DNS server profile of a WLAN.
204
Modify DPSK Setting ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/dpsk
Use this API command to modify DPSK setting of a WLAN.
Body
{
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
}
Schema
{
"description": "DPSK Setting",
"type": "object",
"additionalProperties": false,
"properties": {
"dpskEnabled": {
"description": "DPSK enabled",
"type": "boolean",
"default": false
},
"length": {
"description": "Length of DPSK key",
"type": "integer"
},
"dpskType": {
"description": "Type of DPSK key",
"enum": [
"Secure",
"KeyboardFriendly",
"NumbersOnly"
]
},
"expiration": {
"description": "Expiration of DPSK key",
"enum": [
"Unlimited",
"OneDay",
"TwoDays",
"OneWeek",
"TwoWeeks",
"OneMonth",
"SixMonths",
"OneYear",
"TwoYears"
]
},
"dpskFromType": {
"description": "Type of expiration start from",
"enum": [
"CreateTime",
"FirstUse"
]
}
}
}
204
Modify External DPSK Setting ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/externalDpsk
Use this API command to modify External DPSK setting of a WLAN.
Body
‧ Sample : Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode
{
"enabled" : true,
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES"
},
"authService" : {
"id" : "authServiceUUID"
}
}
‧ Sample : Disable external DPSK with encryption None
{
"enabled" : false,
"encryption" : {
"method" : "None"
}
}
Schema
{
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
}
204
WLAN Scheduler ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/wlanSchedulers
Use this API command to retrieve the list of WLAN schedule from a zone.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "wlanSchedulerUUID",
"name": "wlanSchedulerName",
"description": "wlanSchedulerDescription",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"thu": [
"00:15-01:15"
],
"fri": [
"00:15-01:15"
],
"sat": [
"23:45-24:00"
]
},
{
"id": "wlanSchedulerUUID2",
"name": "wlanSchedulerName2",
"description": "wlanSchedulerDescription2",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"thu": [
"16:15-17:15"
],
"fri": [
"00:30-03:15"
],
"sat": [
"23:45-24:00"
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN schedule",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the WLAN schedule belongs",
"type": "string"
},
"name": {
"description": "Name of the WLAN schedule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN schedule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"sun": {
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string"
}
},
"mon": {
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string"
}
},
"tue": {
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string"
}
},
"wed": {
"description": "Schedules on Wednesday",
"type": "array",
"items": {
"type": "string"
}
},
"thu": {
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string"
}
},
"fri": {
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string"
}
},
"sat": {
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}
Use this API command to retrieve a WLAN schedule.
200
Body
{
"id": "wlanSchedulerUUID",
"zoneId": "zoneUUID",
"name": "wlanSchedulerName",
"description": "wlanSchedulerDescription",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"thu": [
"00:15-01:15"
],
"fri": [
"00:15-01:15"
],
"sat": [
"23:45-24:00"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN schedule",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the WLAN schedule belongs",
"type": "string"
},
"name": {
"description": "Name of the WLAN schedule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN schedule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"sun": {
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string"
}
},
"mon": {
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string"
}
},
"tue": {
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string"
}
},
"wed": {
"description": "Schedules on Wednesday",
"type": "array",
"items": {
"type": "string"
}
},
"thu": {
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string"
}
},
"fri": {
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string"
}
},
"sat": {
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string"
}
}
}
}
Create ¶
POST/v6_1/rkszones/{zoneId}/wlanSchedulers
Use this API command to create a new WLAN schedule.
Body
{
"name": "wlanSchedulerName",
"description": "wlanSchedulerDescription",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15"
],
"thu": [
"00:15-01:15"
],
"fri": [
"00:15-01:15"
],
"sat": [
"23:45-24:00"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the WLAN schedule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN schedule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"sun": {
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"mon": {
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"tue": {
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"wed": {
"description": "Schedules on Wednesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"thu": {
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"fri": {
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"sat": {
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
},
"required": [
"name"
]
}
201
Body
{
"id": "wlanSchedulerUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN schedule",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}
Use this API command to modify the basic information of a WLAN schedule.
Body
{
"name": "wlanSchedulerName",
"description": "wlanSchedulerDescription",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"thu": [
"00:15-01:15"
],
"fri": [
"00:15-01:15"
],
"sat": [
"23:45-24:00"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the WLAN schedule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN schedule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"sun": {
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"mon": {
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"tue": {
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"wed": {
"description": "schedules on Wednesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"thu": {
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"fri": {
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"sat": {
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
}
}
204
Modify Schedules On Sunday ¶
PATCH/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}/sun
Use this API command to modify schedules on Sunday.
Body
[
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
]
Schema
{
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
204
Modify Schedules On Monday ¶
PATCH/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}/mon
Use this API command to modify schedules on Monday.
Body
[
"00:00-01:15",
"13:00-14:00"
]
Schema
{
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
204
Modify Schedule On Tuesday ¶
PATCH/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}/tue
Use this API command to modify schedules on Tuesday.
Body
[
"00:15-01:15"
]
Schema
{
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
204
Modify Schedule On Wednesday ¶
PATCH/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}/wed
Use this API command to modify schedules on Wednesday.
Body
[
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
]
Schema
{
"description": "schedules on Wednesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
204
Modify Schedules On Thursday ¶
PATCH/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}/thu
Use this API command to modify schedules on Thursday.
Body
[
"00:15-01:15"
]
Schema
{
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
204
Modify Schedules On Friday ¶
PATCH/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}/fri
Use this API command to modify schedules on Friday.
Body
[
"00:15-01:15"
]
Schema
{
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
204
Modify Schedules On Saturday ¶
PATCH/v6_1/rkszones/{zoneId}/wlanSchedulers/{id}/sat
Use this API command to modify schedules on Saturday.
Body
[
"23:45-24:00"
]
Schema
{
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
204
Zone AAA ¶
Retrieve List - RADIUS ¶
GET/v6_1/rkszones/{zoneId}/aaa/radius
Use this API command to retrieve a list of radius servers of a zone.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "RADIUSServerUUID",
"mvnoId": "userMVNOId",
"zoneId": "zoneUUID",
"name": "RADIUSServerName",
"description": "RADIUSServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"mappings": [
{
"id": "73587760-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "abc",
"userRole": {
"id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
"name": "identity user role name",
"userTrafficProfile": {
"id": "9474cc20-63cf-11e4-a18a-080027b147d4",
"name": "rapheal-usertraffic-profile"
}
}
},
{
"id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "*",
"userRole": {
"id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
"name": "identity user role name",
"userTrafficProfile": {
"id": "03ec5340-60a4-11e4-87fc-080027b147d4",
"name": "System Default"
}
}
}
]
}
]
}
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 RADIUS server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the RADIUS server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the RADIUS server",
"type": "string"
},
"description": {
"description": "Description of the RADIUS server",
"type": "string"
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
}
}
}
Retrieve - RADIUS ¶
GET/v6_1/rkszones/{zoneId}/aaa/radius/{id}
Use this API command to retrieve a radius server of a zone.
200
Body
{
"id": "RADIUSServerUUID",
"mvnoId": "userMVNOId",
"zoneId": "zoneUUID",
"name": "RADIUSServerName",
"description": "RADIUSServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"mappings": [
{
"id": "73587760-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "abc",
"userRole": {
"id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
"name": "identity user role name",
"userTrafficProfile": {
"id": "9474cc20-63cf-11e4-a18a-080027b147d4",
"name": "rapheal-usertraffic-profile"
}
}
},
{
"id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "*",
"userRole": {
"id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
"name": "identity user role name",
"userTrafficProfile": {
"id": "03ec5340-60a4-11e4-87fc-080027b147d4",
"name": "System Default"
}
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the RADIUS server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the RADIUS server",
"type": "string"
},
"description": {
"description": "Description of the RADIUS server",
"type": "string"
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
Create - RADIUS ¶
POST/v6_1/rkszones/{zoneId}/aaa/radius
Use this API command to create a new radius server of a zone.
- forAccounting
string
(optional)radius server for accounting type. default: false.
Body
{
"name": "RADIUSServerName",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the RADIUS server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
},
"required": [
"name",
"primary"
]
}
201
Body
{
"id": "RADIUSServerUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify Entire - RADIUS ¶
PUT/v6_1/rkszones/{zoneId}/aaa/radius/{id}
Use this API command to modify the basic information on radius server of a zone by complete attributes.
Body
{
"name": "RADIUSServerName",
"description": "RADIUSServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "abc"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the RADIUS server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Modify - RADIUS ¶
PATCH/v6_1/rkszones/{zoneId}/aaa/radius/{id}
Use this API command to modify the basic information on radius server of a zone.
Body
{
"name": "RADIUSServerName",
"description": "RADIUSServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "abc"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the RADIUS server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Modify - Primary Server of RADIUS ¶
PATCH/v6_1/rkszones/{zoneId}/aaa/radius/{id}/primary
Use this API command to modify primary server on radius server of a zone.
Body
{
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "abc"
}
Schema
{
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
204
Modify - Secondary Server of RADIUS ¶
PATCH/v6_1/rkszones/{zoneId}/aaa/radius/{id}/secondary
Use this API command to modify secondary server on radius server of a zone.
Body
{
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
}
Schema
{
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
204
Disable Secondary Server - RADIUS ¶
DELETE/v6_1/rkszones/{zoneId}/aaa/radius/{id}/secondary
Use this API command to disable secondary server on radius server of a zone.
204
Delete - RADIUS ¶
DELETE/v6_1/rkszones/{zoneId}/aaa/radius/{id}
Use this API command to delete a radius server of a zone.
204
Delete AAA server ¶
Delete a list of AAA server ¶
DELETE/v6_1/rkszones/{zoneId}/aaa
Use this API command to delete a list of AAA server.
Body
{
"idList": [
"839f87c6-d116-497e-afce-aa8157abdasd"
]
}
204
Retrieve List - RADIUS Accounting ¶
GET/v5_1/rkszones/{zoneId}/aaa/accounting
Use this API command to retrieve a list of radius accounting servers of a zone.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "accountingServerUUID",
"mvnoId": "userMVNOId",
"zoneId": "zoneUUID",
"name": "accountingServerName",
"description": "accountingServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1813,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1813,
"sharedSecret": "sharedSecret"
}
}
]
}
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 accounting server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the accounting server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the accounting server",
"type": "string"
},
"description": {
"description": "Description of the accounting server",
"type": "string"
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
}
}
}
}
}
Retrieve - RADIUS Accounting ¶
GET/v5_1/rkszones/{zoneId}/aaa/accounting/{id}
Use this API command to retrieve a radius accounting server of a zone.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
200
Body
{
"id": "accountingServerUUID",
"mvnoId": "userMVNOId",
"zoneId": "zoneUUID",
"name": "accountingServerName",
"description": "accountingServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1813,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1813,
"sharedSecret": "sharedSecret"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the accounting server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the accounting server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the accounting server",
"type": "string"
},
"description": {
"description": "Description of the accounting server",
"type": "string"
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
}
}
Create - RADIUS Accounting ¶
POST/v5_1/rkszones/{zoneId}/aaa/accounting
Use this API command to create a new radius accounting server of a zone.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
Body
{
"name": "accountingServerName",
"primary": {
"ip": "192.168.1.1",
"port": 1813,
"sharedSecret": "sharedSecret"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the accounting server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the accounting server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
},
"required": [
"name",
"primary"
]
}
201
Body
{
"id": "RADIUSServerUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify - RADIUS Accounting ¶
PATCH/v5_1/rkszones/{zoneId}/aaa/accounting/{id}
Use this API command to modify the basic information on radius accounting server of a zone.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
Body
{
"name": "accountingServerName",
"description": "accountingServerDescription",
"primary": {
"ip": "1.1.1.1",
"port": 1813,
"sharedSecret": "abc"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1813,
"sharedSecret": "sharedSecret"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the accounting server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the accounting server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
}
}
204
Modify - Primary Server of RADIUS Accounting ¶
PATCH/v5_1/rkszones/{zoneId}/aaa/accounting/{id}/primary
Use this API command to modify primary server on radius accounting server of a zone.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
Body
{
"ip": "1.1.1.1",
"port": 1813,
"sharedSecret": "abc"
}
Schema
{
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
204
Modify - Secondary Server of RADIUS Accounting ¶
PATCH/v5_1/rkszones/{zoneId}/aaa/accounting/{id}/secondary
Use this API command to modify secondary server on radius accounting server of a zone.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
Body
{
"ip": "192.168.1.2",
"port": 1813,
"sharedSecret": "sharedSecret"
}
Schema
{
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
204
Disable Secondary Server - RADIUS Accounting ¶
DELETE/v5_1/rkszones/{zoneId}/aaa/accounting/{id}/secondary
Use this API command to disable secondary server on radius accounting server of a zone.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
204
Delete - RADIUS Accounting ¶
DELETE/v5_1/rkszones/{zoneId}/aaa/accounting/{id}
Use this API command to delete a radius accounting server of a zone.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
204
Retrieve List - ActiveDirectory ¶
GET/v6_1/rkszones/{zoneId}/aaa/ad
Use this API command to retrieve a list of active directory servers of a zone.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
"name": "activeDirectoryServerName",
"description": null,
"ip": "192.168.1.1",
"port": 389,
"windowsDomainName": null,
"adminDomainName": null,
"password": "",
"globalCatalogEnabled": false,
"mappings": [
{
"id": "c7608860-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
]
}
]
}
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 active directory server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the active directory server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the active directory server",
"type": "string"
},
"description": {
"description": "Description of the active directory server",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
}
}
}
Retrieve - ActiveDirectory ¶
GET/v6_1/rkszones/{zoneId}/aaa/ad/{id}
Use this API command to retrieve an active directory server of a zone.
200
Body
{
"id": "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
"name": "activeDirectoryServerName",
"description": null,
"ip": "192.168.1.1",
"port": 389,
"windowsDomainName": null,
"adminDomainName": null,
"password": "",
"globalCatalogEnabled": false,
"mappings": [
{
"id": "c7608860-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the active directory server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the active directory server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the active directory server",
"type": "string"
},
"description": {
"description": "Description of the active directory server",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
Create - ActiveDirectory ¶
POST/v6_1/rkszones/{zoneId}/aaa/ad
Use this API command to create a new active directory server of a zone.
Body
{
"name": "activeDirectoryServerName",
"ip": "192.168.1.1",
"port": 389,
"globalCatalogEnabled": false,
"windowsDomainName": "dc=domain,dc=ruckuswireless,dc=com"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the active directory server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the active directory server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
},
"required": [
"name",
"ip",
"port",
"globalCatalogEnabled",
"windowsDomainName"
]
}
201
Body
{
"id": "RADIUSServerUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify Entire - ActiveDirectory ¶
PUT/v6_1/rkszones/{zoneId}/aaa/ad/{id}
Use this API command to modify the basic information on active directory server of a zone by complete attributes.
Body
{
"name": "new name",
"ip": "192.168.1.2",
"port": 3268,
"globalCatalogEnabled": true,
"adminDomainName": "[email protected]",
"password": "admin",
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the active directory server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the active directory server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Modify - ActiveDirectory ¶
PATCH/v6_1/rkszones/{zoneId}/aaa/ad/{id}
Use this API command to modify the basic information on active directory server of a zone.
Body
{
"name": "new name",
"ip": "192.168.1.2",
"port": 3268,
"globalCatalogEnabled": true,
"adminDomainName": "[email protected]",
"password": "admin",
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the active directory server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the active directory server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Delete - ActiveDirectory ¶
DELETE/v6_1/rkszones/{zoneId}/aaa/ad/{id}
Use this API command to delete an active directory server of a zone.
204
Retrieve List - LDAP ¶
GET/v6_1/rkszones/{zoneId}/aaa/ldap
Use this API command to retrieve a list of LDAP servers of a zone.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "32fb8816-60e7-46df-876b-038c655278d4",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
"name": "rapheal-ldap",
"description": "",
"ip": "1.1.1.1",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "objectClass=*",
"mappings": [
{
"id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
},
{
"id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "abcd",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
]
}
]
}
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 LDAP server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the LDAP server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the LDAP server",
"type": "string"
},
"description": {
"description": "Description of the LDAP server",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"baseDomainName": {
"description": "Base domain name",
"type": "string"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string"
},
"searchFilter": {
"description": "Search filter",
"type": "string"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
}
}
}
Retrieve - LDAP ¶
GET/v6_1/rkszones/{zoneId}/aaa/ldap/{id}
Use this API command to retrieve a LDAP server of a zone.
200
Body
{
"id": "32fb8816-60e7-46df-876b-038c655278d4",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
"name": "rapheal-ldap",
"description": "",
"ip": "1.1.1.1",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "objectClass=*",
"mappings": [
{
"id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
},
{
"id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "abcd",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the LDAP server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the LDAP server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the LDAP server",
"type": "string"
},
"description": {
"description": "Description of the LDAP server",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"baseDomainName": {
"description": "Base domain name",
"type": "string"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string"
},
"searchFilter": {
"description": "Search filter",
"type": "string"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
Create - LDAP ¶
POST/v6_1/rkszones/{zoneId}/aaa/ldap
Use this API command to create a new LDAP server of a zone.
Body
{
"name": "rapheal-ldap",
"ip": "1.1.1.2",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "objectClass=*"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the LDAP server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the LDAP server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
},
"required": [
"name",
"ip",
"port",
"baseDomainName",
"adminDomainName",
"password",
"keyAttribute",
"searchFilter"
]
}
201
Body
{
"id": "RADIUSServerUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify Entire - LDAP ¶
PUT/v6_1/rkszones/{zoneId}/aaa/ldap/{id}
Use this API command to modify the basic information on LDAP server of a zone by complete attributes.
Body
{
"name": "rapheal-ldap2",
"ip": "1.1.1.22",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "objectClass=*",
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the LDAP server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the LDAP server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Modify - LDAP ¶
PATCH/v6_1/rkszones/{zoneId}/aaa/ldap/{id}
Use this API command to modify the basic information on LDAP server of a zone.
Body
{
"name": "rapheal-ldap2",
"ip": "1.1.1.22",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "objectClass=*",
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the LDAP server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the LDAP server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Web Authentication ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/portals/webauth
Use this API command to retrieve a list of web authentication of a zone.
200
Body
{
"totalCount": 9,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "portalName1"
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "portalName2"
},
{
"id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name": "portalName3"
},
{
"id": "7f0eef00-7423-11e4-bcef-000c299b4765",
"name": "portalName4"
},
{
"id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name": "portalName5"
},
{
"id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name": "portalName6"
},
{
"id": "afebbc80-73be-11e4-bfde-f0def13d5845",
"name": "portalName7"
},
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name": "portalName8"
},
{
"id": "96308310-752c-11e4-8276-00606eb0c700",
"name": "portalName9"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/portals/webauth/{id}
Use this API command to retrieve a web authentication of a zone.
200
Body
{
"name": "Web Authentication Modify",
"id": "3e769bc0-7ead-11e4-9517-00606eb0c700",
"description": "Web Authentication Modify Description",
"portalLanguage": "en_US",
"redirect": {
"url": "https://www.ruckuswireless.com"
},
"userSession": {
"timeoutInMin": 180,
"gracePeriodInMin": 120
},
"zoneId": "b4187899-38ae-4ace-8e40-0bc444455156"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the web authentication profile",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the web authentication profile belongs to",
"type": "string"
},
"name": {
"description": "Name of the web authentication profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the web authentication profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"portalLanguage": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"redirect": {
"description": "Redirect configuration of the web authentication profile",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"userSession": {
"description": "User session of the web authentication profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
}
}
Create ¶
POST/v6_1/rkszones/{zoneId}/portals/webauth
Use this API command to create a new web authentication of a zone.
Body
{
"name": "Web Authentication Create",
"description": "Web Authentication Create Description"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the web authentication profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the web authentication profile",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"name"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/portals/webauth/{id}
Use this API command to modify the basic information on web authentication of a zone.
Body
{
"name": "Web Authentication Modify",
"description": "Web Authentication Modify Description",
"portalLanguage": "en_US",
"redirect": {
"url": "https://www.ruckuswireless.com"
},
"userSession": {
"timeoutInMin": 180,
"gracePeriodInMin": 120
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the web authentication profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the web authentication profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"portalLanguage": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"redirect": {
"description": "Redirect configuration of the web authentication profile",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"userSession": {
"description": "User session of the web authentication profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
}
}
204
Modify Redirect ¶
PATCH/v6_1/rkszones/{zoneId}/portals/webauth/{id}/redirect
Use this API command to modify the redirect information on web authentication of a zone.
Body
{
"url": "https://www.ruckuswireless.com"
}
Schema
{
"description": "Redirect configuration of the web authentication profile",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
}
204
Redirect to URL user visit ¶
DELETE/v6_1/rkszones/{zoneId}/portals/webauth/{id}/redirect
Use this API command to set redirect to the URL that user intends to visit on web authentication of a zone.
204
Modify UserSession ¶
PATCH/v6_1/rkszones/{zoneId}/portals/webauth/{id}/userSession
Use this API command to modify the user session on web authentication of a zone.
Body
{
"timeoutInMin": 180,
"gracePeriodInMin": 120
}
Schema
{
"description": "User session of the web authentication profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
204
Guest Access ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/portals/guest
Use this API command to retrieve a list of guest access of a zone.
200
Body
{
"totalCount": 9,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "portalName1"
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "portalName2"
},
{
"id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name": "portalName3"
},
{
"id": "7f0eef00-7423-11e4-bcef-000c299b4765",
"name": "portalName4"
},
{
"id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name": "portalName5"
},
{
"id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name": "portalName6"
},
{
"id": "afebbc80-73be-11e4-bfde-f0def13d5845",
"name": "portalName7"
},
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name": "portalName8"
},
{
"id": "96308310-752c-11e4-8276-00606eb0c700",
"name": "portalName9"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/portals/guest/{id}
Use this API command to retrieve guest access of a zone.
200
Body
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"zoneId": "d664f517-cdc5-4997-8248-980a0b7a0542",
"name": "GuestAccessSmart",
"description": "basic configuration test",
"portalCustomization": {
"language": "en_US",
"title": "Welcome to the Guest Access login page.",
"logo": "logo description",
"termsAndConditionsText": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"termsAndConditionsRequired": true
},
"redirect": {
"url": "http://www.google.com"
},
"smsGateway": null,
"userSession": {
"timeoutInMin": 180,
"gracePeriodInMin": 120
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the guest access profile",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the guest access profile belongs to",
"type": "string"
},
"name": {
"description": "Name of the guest access profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the guest access profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"portalCustomization": {
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
},
"redirect": {
"description": "Redirect configuration of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"smsGateway": {
"description": "Portal SMS gateway of the guest access profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"userSession": {
"description": "User session of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
}
}
Create ¶
POST/v6_1/rkszones/{zoneId}/portals/guest
Use this API command to create new guest access of a zone.
Body
{
"name": "GuestAccess test",
"description": "guest access test description",
"portalCustomization": {
"language": "en_US",
"title": "Welcome to the Guest Access login page.",
"logo": "test",
"termsAndConditionsRequired": true,
"termsAndConditionsText": "test"
},
"redirect": {
"url": "http://www.ruckuswireless.com"
},
"smsGateway": {
"name": "defaultServer"
},
"userSession": {
"timeoutInMin": 180,
"gracePeriodInMin": 120
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the guest access profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the guest access profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"portalCustomization": {
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
},
"redirect": {
"description": "Redirect configuration of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"smsGateway": {
"description": "Portal SMS gateway of the guest access profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"userSession": {
"description": "Redirect configuration of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
},
"required": [
"name",
"portalCustomization",
"userSession"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/portals/guest/{id}
Use this API command to modify the basic information on guest access of a zone.
Body
{
"name": "GuestAccessSmart",
"description": "basic configuration test",
"portalCustomization": {
"language": "zh_TW",
"title": "Welcome to the Guest Access login page.",
"logo": "logo description",
"termsAndConditionsRequired": true,
"termsAndConditionsText": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless."
},
"redirect": {
"url": "http://www.google.com"
},
"smsGateway": {
"name": "defaultServer"
},
"userSession": {
"timeoutInMin": 180,
"gracePeriodInMin": 60
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the guest access profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the guest access profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"portalCustomization": {
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
},
"redirect": {
"description": "Redirect configuration of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"smsGateway": {
"description": "Portal SMS gateway of the guest access profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"userSession": {
"description": "User session of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
}
}
204
Modify redirect ¶
PATCH/v6_1/rkszones/{zoneId}/portals/guest/{id}/redirect
Use this API command to modify the redirect information on guest access of a zone.
Body
{
"url": "http://www.google.com"
}
Schema
{
"description": "Redirect configuration of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
}
204
Redirect to URL user visit ¶
DELETE/v6_1/rkszones/{zoneId}/portals/guest/{id}/redirect
Use this API command to set redirect to the URL that user intends to visit on guest access of a zone.
204
Modify SMS Gateway ¶
PATCH/v6_1/rkszones/{zoneId}/portals/guest/{id}/smsGateway
Use this API command to modify SMS gateway on guest access of a zone.
Body
{
"name": "defaultServer"
}
Schema
{
"description": "Portal SMS gateway of the guest access profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable SMS Gateway ¶
DELETE/v6_1/rkszones/{zoneId}/portals/guest/{id}/smsGateway
Use this API command to disable SMS gateway on guest access of a zone.
204
Modify Portal Customization ¶
PATCH/v6_1/rkszones/{zoneId}/portals/guest/{id}/portalCustomization
Use this API command to modify the portal customization on guest access of a zone.
Body
{
"language": "zh_TW",
"title": "Welcome to the Guest Access login page.",
"logo": "logo description",
"termsAndConditionsRequired": true,
"termsAndConditionsText": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless."
}
Schema
{
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
}
204
Modify User Session ¶
PATCH/v6_1/rkszones/{zoneId}/portals/guest/{id}/userSession
Use this API command to modify the user session on guest access of a zone.
Body
{
"timeoutInMin": 180,
"gracePeriodInMin": 60
}
Schema
{
"description": "User session of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
204
Hotspot Service ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/portals/hotspot
Use this API command to retrieve a list of Hotspot (WISPr) of a zone.
200
Body
{
"totalCount": 9,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "portalName1"
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "portalName2"
},
{
"id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name": "portalName3"
},
{
"id": "7f0eef00-7423-11e4-bcef-000c299b4765",
"name": "portalName4"
},
{
"id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name": "portalName5"
},
{
"id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name": "portalName6"
},
{
"id": "afebbc80-73be-11e4-bfde-f0def13d5845",
"name": "portalName7"
},
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name": "portalName8"
},
{
"id": "96308310-752c-11e4-8276-00606eb0c700",
"name": "portalName9"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/portals/hotspot/{id}
Use this API command to retrieve a Hotspot (WISPr) of zone.
200
Body
{
"name": "test-hotspot222",
"id": "3e5b3782-6f1a-42bf-9812-95d2c1df2451",
"description": "description",
"smartClientSupport": "None",
"smartClientInfo": null,
"portalType": "Internal",
"portalUrl": null,
"redirect": null,
"portalCustomization": {
"language": "en_US",
"title": "Ruckus Wireless - Subscriber Portal",
"logo": "logo",
"termsAndConditionsRequired": false
},
"userSession": {
"timeoutInMin": 1440,
"gracePeriodInMin": 60
},
"location": {
"id": "locationId",
"name": "locationName"
},
"macAddressFormat": 2,
"walledGardens": [
"10.1.1.1",
"11.11.111.11"
],
"zoneId": "d664f517-cdc5-4997-8248-980a0b7a0542",
"httpsRedirect": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Hotspot",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the Hotspot belongs to",
"type": "string"
},
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientSupport": {
"description": "Smart client support of the Hotspot",
"enum": [
"None",
"Enabled",
"SmartClientOnly"
]
},
"smartClientInfo": {
"description": "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
"type": "string"
},
"portalType": {
"description": "Portal type of the Hotspot",
"enum": [
"Internal",
"External"
]
},
"portalUrl": {
"description": "Portal URL of the Hotspot",
"type": "string"
},
"location": {
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"portalCustomization": {
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
},
"userSession": {
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
}
}
Create Internal ¶
POST/v6_1/rkszones/{zoneId}/portals/hotspot/internal
Use this API command to create a new Hotspot (WISPr) with internal logon URL of a zone.MacAddressFormat.
Body
{
"name": "test-hotspot222",
"description": "description",
"smartClientSupport": "None",
"location": {
"id": "locationId",
"name": "locationName"
},
"macAddressFormat": 2,
"walledGardens": [
"10.11.12.16",
"10.11.12.13"
],
"httpsRedirect": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientSupport": {
"description": "Smart client support of the Hotspot",
"enum": [
"None",
"Enabled"
]
},
"location": {
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"userSession": {
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
},
"required": [
"name",
"smartClientSupport",
"macAddressFormat"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Create External ¶
POST/v6_1/rkszones/{zoneId}/portals/hotspot/external
Use this API command to create a new Hotspot (WISPr) with external logon URL of a zone.MacAddressFormat.
Body
{
"name": "test-hotspot222",
"description": "description",
"smartClientSupport": "None",
"portalUrl": "https://172.17.26.59",
"location": {
"id": "locationId",
"name": "locationName"
},
"macAddressFormat": 2,
"walledGardens": [
"10.11.12.16",
"10.11.12.13"
],
"httpsRedirect": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientSupport": {
"description": "Smart client support of the Hotspot",
"enum": [
"None",
"Enabled"
]
},
"portalUrl": {
"description": "Portal URL of the Hotspot",
"type": "string"
},
"location": {
"description": "Location of the hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"userSession": {
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
},
"required": [
"name",
"smartClientSupport",
"portalUrl",
"macAddressFormat"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Create Smart Client Only ¶
POST/v6_1/rkszones/{zoneId}/portals/hotspot/smartClientOnly
Use this API command to create a new Hotspot (WISPr) with smart client only of a zone.MacAddressFormat.
Body
{
"name": "test-hotspot222-smartClientOnly",
"description": "description-smartClientOnly",
"smartClientInfo": "smartClient only, yyyy!",
"location": {
"id": "locationId",
"name": "locationName"
},
"macAddressFormat": 2,
"walledGardens": [
"10.11.12.16",
"10.11.12.13"
],
"httpsRedirect": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientInfo": {
"description": "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
"type": "string"
},
"location": {
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"userSession": {
"description": "Redirect configuration of the Hotspot profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
},
"required": [
"name",
"smartClientInfo",
"macAddressFormat"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/portals/hotspot/{id}
Use this API command to modify the basic information on Hotspot (WISPr) of a zone.MacAddressFormat.
Body
{
"name": "test-hotspot-modify",
"description": "description-modify",
"smartClientSupport": "Enabled",
"portalUrl": "https://172.17.26.59",
"location": {
"id": "locationId",
"name": "locationName"
},
"redirect": {
"url": "https://www.testurl.com"
},
"portalCustomization": {
"language": "en_US",
"title": "Ruckus Wireless - Subscriber Portal",
"logo": "logo",
"termsAndConditionsRequired": false
},
"userSession": {
"timeoutInMin": 1440,
"gracePeriodInMin": 60
},
"macAddressFormat": 2,
"walledGardens": [
"10.1.1.1",
"11.11.111.11"
],
"httpsRedirect": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientSupport": {
"description": "Smart client support of the Hotspot",
"enum": [
"None",
"Enabled"
]
},
"smartClientInfo": {
"description": "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
"type": "string"
},
"portalUrl": {
"description": "Portal URL of the Hotspot",
"type": "string"
},
"location": {
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"portalCustomization": {
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
},
"userSession": {
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
}
}
204
Modify Redirect ¶
PATCH/v6_1/rkszones/{zoneId}/portals/hotspot/{id}/redirect
Use this API command to modify the redirect information on Hotspot (WISPr) of a zone.
Body
{
"url": "https://www.testurl.com"
}
Schema
{
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
}
204
Modify Portal Customization ¶
PATCH/v6_1/rkszones/{zoneId}/portals/hotspot/{id}/portalCustomization
Use this API command to modify portal customization on Hotspot (WISPr) of a zone.
Body
{
"language": "en_US",
"title": "Ruckus Wireless - Subscriber Portal",
"logo": "logo",
"termsAndConditionsRequired": false
}
Schema
{
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
}
204
Modify User Session ¶
PATCH/v6_1/rkszones/{zoneId}/portals/hotspot/{id}/userSession
Use this API command to modify user session on Hotspot (WISPr) of a zone.
Body
{
"timeoutInMin": 1440,
"gracePeriodInMin": 60
}
Schema
{
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
204
Modify Location ¶
PATCH/v6_1/rkszones/{zoneId}/portals/hotspot/{id}/location
Use this API command to modify the location information on Hotspot (WISPr) of a zone.
Body
{
"id": "locationId",
"name": "locationName"
}
Schema
{
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
}
204
Modify Walled Gardens ¶
PATCH/v6_1/rkszones/{zoneId}/portals/hotspot/{id}/walledGardens
Use this API command to modify walled gardens on Hotspot (WISPr) of a zone.
Body
[
"10.1.1.1",
"11.11.111.11"
]
Schema
{
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
}
204
Hotspot20 WLAN Service ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/hs20s
Use this API command to retrieve a list of Hotspot 2.0 WLAN profiles of a zone.
200
Body
{
"totalCount": 9,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "portalName1"
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "portalName2"
},
{
"id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name": "portalName3"
},
{
"id": "7f0eef00-7423-11e4-bcef-000c299b4765",
"name": "portalName4"
},
{
"id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name": "portalName5"
},
{
"id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name": "portalName6"
},
{
"id": "afebbc80-73be-11e4-bfde-f0def13d5845",
"name": "portalName7"
},
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name": "portalName8"
},
{
"id": "96308310-752c-11e4-8276-00606eb0c700",
"name": "portalName9"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/hs20s/{id}
Use this API command to retrieve a Hotspot 2.0 WLAN profile of a zone.
200
Body
{
"id": "b6af6e80-8409-11e4-a4e7-80fa5b024259",
"name": "test-hs20Wlan",
"description": "test-hs20Wlan-desc",
"operator": {
"id": "e6373c40-8194-11e4-aa2e-000c299b4765",
"name": "operatorTEST"
},
"identityProviders": [
{
"id": "9eec1055-45dd-45c5-a631-f1b76530bb67",
"name": "identityProviderDisabled"
},
{
"id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name": "identityProviderEnabled"
}
],
"defaultIdentityProvider": {
"id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name": "identityProviderEnabled"
},
"signupSsid": {
"id": "1",
"name": "osenWlan"
},
"internetOption": true,
"accessNetworkType": "FREE_PUBLIC",
"ipv4AddressType": "UNAVAILABLE",
"ipv6AddressType": "UNAVAILABLE",
"connectionCapabilities": [
{
"protocolName": "ICMP",
"protocolNumber": 1,
"portNumber": 0,
"status": "OPEN"
},
{
"protocolName": "FTP",
"protocolNumber": 6,
"portNumber": 20,
"status": "OPEN"
},
{
"protocolName": "SSH",
"protocolNumber": 6,
"portNumber": 22,
"status": "CLOSED"
},
{
"protocolName": "HTTP",
"protocolNumber": 6,
"portNumber": 80,
"status": "CLOSED"
},
{
"protocolName": "Used by TLS VPN",
"protocolNumber": 6,
"portNumber": 443,
"status": "CLOSED"
},
{
"protocolName": "Used by PPTP VPNs",
"protocolNumber": 6,
"portNumber": 1723,
"status": "CLOSED"
},
{
"protocolName": "VoIP",
"protocolNumber": 6,
"portNumber": 5060,
"status": "CLOSED"
},
{
"protocolName": "VoIP",
"protocolNumber": 17,
"portNumber": 5060,
"status": "CLOSED"
},
{
"protocolName": "Used by IKEv2(IPSec VPN)",
"protocolNumber": 17,
"portNumber": 500,
"status": "CLOSED"
},
{
"protocolName": "IPSec VPN",
"protocolNumber": 17,
"portNumber": 4500,
"status": "CLOSED"
},
{
"protocolName": "ESP",
"protocolNumber": 50,
"portNumber": 0,
"status": "CLOSED"
}
],
"customConnectionCapabilities": [
{
"protocolName": "ICMP",
"protocolNumber": 2,
"portNumber": 0,
"status": "OPEN"
},
{
"protocolName": "FTP",
"protocolNumber": 2,
"portNumber": 20,
"status": "OPEN"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Hotspot 2.0 WLAN profile",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the Hotspot 2.0 WLAN profile belongs to",
"type": "string"
},
"name": {
"description": "Name of the Hotspot 2.0 WLAN profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot 2.0 WLAN profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"operator": {
"description": "Operator of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"identityProviders": {
"description": "Identity providers of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"defaultIdentityProvider": {
"description": "Default identity provider of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"signupSsid": {
"description": "Signup SSID of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"internetOption": {
"description": "Internet option of the Hotspot 2.0 WLAN profile",
"type": "boolean"
},
"accessNetworkType": {
"description": "Access network type of the Hotspot 2.0 WLAN profile",
"enum": [
"CHARGEABLE_PUBLIC",
"FREE_PUBLIC",
"PERSONAL_DEVICE",
"PRIVATE",
"PRIVATE_WITH_GUEST",
"TEST",
"WILDCARD"
]
},
"ipv4AddressType": {
"description": "IPv4 address type of the v WLAN profile",
"enum": [
"UNAVAILABLE",
"PUBLIC",
"PORT_RESTRICTED",
"SINGLE_NATED_PRIVATE",
"DOUBLE_NATED_PRIVATE",
"PORT_RESTRICTED_AND_SINGLE_NATED",
"PORT_RESTRICTED_AND_DOUBLE_NATED",
"UNKNOWN"
]
},
"ipv6AddressType": {
"description": "IPv6 address type of the Hotspot 2.0 WLAN profile",
"enum": [
"UNAVAILABLE",
"AVAILABLE",
"UNKNOWN"
]
},
"connectionCapabilities": {
"description": "Default connection capabilities of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"protocolName": {
"description": "Protocol aame of connection capability, cannot be modified",
"type": "string",
"pattern": "^[!-~]([ -~]){0,31}$"
},
"protocolNumber": {
"description": "Protocol number of connection capability, cannot be modified",
"type": "number",
"minimum": 0,
"maximum": 254
},
"portNumber": {
"description": "Port number of connection capability, cannot be modified",
"type": "number",
"minimum": 0,
"maximum": 65535
},
"status": {
"description": "Status of connection capability",
"enum": [
"CLOSED",
"OPEN",
"UNKNOWN"
]
}
},
"required": [
"protocolName",
"protocolNumber",
"portNumber",
"status"
]
}
},
"customConnectionCapabilities": {
"description": "Custom connection capabilities of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"protocolName": {
"description": "Protocol aame of connection capability",
"type": "string",
"pattern": "^[!-~]([ -~]){0,31}$"
},
"protocolNumber": {
"description": "Protocol number of connection capability",
"type": "number",
"minimum": 0,
"maximum": 254
},
"portNumber": {
"description": "Port number of connection capability",
"type": "number",
"minimum": 0,
"maximum": 65535
},
"status": {
"description": "Status of connection capability",
"enum": [
"CLOSED",
"OPEN",
"UNKNOWN"
]
}
},
"required": [
"protocolName",
"protocolNumber",
"portNumber",
"status"
]
}
}
}
}
Create ¶
POST/v6_1/rkszones/{zoneId}/hs20s
Use this API command to create a new Hotspot 2.0 WLAN profile of a zone.
Body
{
"name": "hotspot20WlanCreate",
"description": "hotspot20 Wlan profile Create desc",
"operator": {
"id": "e6373c40-8194-11e4-aa2e-000c299b4765",
"name": "operatorTEST"
},
"identityProviders": [
{
"id": "9eec1055-45dd-45c5-a631-f1b76530bb67",
"name": "identityProviderDisabled"
},
{
"id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name": "identityProviderEnabled"
}
],
"defaultIdentityProvider": {
"id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name": "identityProviderEnabled"
},
"signupSsid": {
"id": "1",
"name": "osenWlan"
},
"internetOption": true,
"accessNetworkType": "CHARGEABLE_PUBLIC",
"ipv4AddressType": "UNAVAILABLE",
"ipv6AddressType": "UNAVAILABLE"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot 2.0 WLAN profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot 2.0 WLAN profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"operator": {
"description": "Operator of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"identityProviders": {
"description": "Ddentity providers of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"defaultIdentityProvider": {
"description": "Default identity provider of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"signupSsid": {
"description": "Signup SSID of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"internetOption": {
"description": "Internet option of the Hotspot 2.0 WLAN profile",
"type": "boolean"
},
"accessNetworkType": {
"description": "Access network type of the Hotspot 2.0 WLAN profile",
"enum": [
"CHARGEABLE_PUBLIC",
"FREE_PUBLIC",
"PERSONAL_DEVICE",
"PRIVATE",
"PRIVATE_WITH_GUEST",
"TEST",
"WILDCARD"
]
},
"ipv4AddressType": {
"description": "IPv4 address type of the Hotspot 2.0 WLAN profile",
"enum": [
"UNAVAILABLE",
"PUBLIC",
"PORT_RESTRICTED",
"SINGLE_NATED_PRIVATE",
"DOUBLE_NATED_PRIVATE",
"PORT_RESTRICTED_AND_SINGLE_NATED",
"PORT_RESTRICTED_AND_DOUBLE_NATED",
"UNKNOWN"
]
},
"ipv6AddressType": {
"description": "IPv6 address type of the Hotspot 2.0 WLAN profile",
"enum": [
"UNAVAILABLE",
"AVAILABLE",
"UNKNOWN"
]
}
},
"required": [
"name",
"operator",
"defaultIdentityProvider",
"internetOption",
"accessNetworkType",
"ipv4AddressType",
"ipv6AddressType"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/hs20s/{id}
Use this API command to modify the basic information on Hotspot 2.0 WLAN profile of a zone.
Body
{
"name": "hotspot20WlanProfilePath",
"description": "hotspot20 wlan profile pathc desc",
"operator": {
"id": "e6373c40-8194-11e4-aa2e-000c299b4765",
"name": "operatorTEST"
},
"identityProviders": [
{
"id": "9eec1055-45dd-45c5-a631-f1b76530bb67",
"name": "identityProviderDisabled"
},
{
"id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name": "identityProviderEnabled"
}
],
"defaultIdentityProvider": {
"id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name": "identityProviderEnabled"
},
"signupSsid": {
"id": "1",
"name": "osenWlan"
},
"internetOption": true,
"accessNetworkType": "CHARGEABLE_PUBLIC",
"ipv4AddressType": "UNAVAILABLE",
"ipv6AddressType": "UNAVAILABLE",
"connectionCapabilities": [
{
"protocolName": "ICMP",
"protocolNumber": 1,
"portNumber": 0,
"status": "OPEN"
},
{
"protocolName": "FTP",
"protocolNumber": 6,
"portNumber": 20,
"status": "OPEN"
},
{
"protocolName": "SSH",
"protocolNumber": 6,
"portNumber": 22,
"status": "UNKNOWN"
},
{
"protocolName": "HTTP",
"protocolNumber": 6,
"portNumber": 80,
"status": "CLOSED"
},
{
"protocolName": "Used by TLS VPN",
"protocolNumber": 6,
"portNumber": 443,
"status": "CLOSED"
},
{
"protocolName": "Used by PPTP VPNs",
"protocolNumber": 6,
"portNumber": 1723,
"status": "CLOSED"
},
{
"protocolName": "VoIP",
"protocolNumber": 6,
"portNumber": 5060,
"status": "CLOSED"
},
{
"protocolName": "VoIP",
"protocolNumber": 17,
"portNumber": 5060,
"status": "CLOSED"
},
{
"protocolName": "Used by IKEv2(IPSec VPN)",
"protocolNumber": 17,
"portNumber": 500,
"status": "CLOSED"
},
{
"protocolName": "IPSec VPN",
"protocolNumber": 17,
"portNumber": 4500,
"status": "CLOSED"
},
{
"protocolName": "ESP",
"protocolNumber": 50,
"portNumber": 0,
"status": "CLOSED"
}
],
"customConnectionCapabilities": [
{
"protocolName": "ICMP",
"protocolNumber": 2,
"portNumber": 0,
"status": "OPEN"
},
{
"protocolName": "FTP",
"protocolNumber": 2,
"portNumber": 20,
"status": "OPEN"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot 2.0 WLAN profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot 2.0 WLAN profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"operator": {
"description": "Operator of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"identityProviders": {
"description": "Identity providers of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"defaultIdentityProvider": {
"description": "Default identity provider of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"signupSsid": {
"description": "Signup SSID of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"internetOption": {
"description": "Internet option of the Hotspot 2.0 WLAN profile",
"type": "boolean"
},
"accessNetworkType": {
"description": "Access network type of the Hotspot 2.0 WLAN profile",
"enum": [
"CHARGEABLE_PUBLIC",
"FREE_PUBLIC",
"PERSONAL_DEVICE",
"PRIVATE",
"PRIVATE_WITH_GUEST",
"TEST",
"WILDCARD"
]
},
"ipv4AddressType": {
"description": "IPv4 address type of the Hotspot 2.0 Wlan profile",
"enum": [
"UNAVAILABLE",
"PUBLIC",
"PORT_RESTRICTED",
"SINGLE_NATED_PRIVATE",
"DOUBLE_NATED_PRIVATE",
"PORT_RESTRICTED_AND_SINGLE_NATED",
"PORT_RESTRICTED_AND_DOUBLE_NATED",
"UNKNOWN"
]
},
"ipv6AddressType": {
"description": "IPv6 address type of the Hotspot 2.0 Wlan profile",
"enum": [
"UNAVAILABLE",
"AVAILABLE",
"UNKNOWN"
]
},
"connectionCapabilities": {
"description": "Default connection capabilities of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"protocolName": {
"description": "Protocol aame of connection capability, cannot be modified",
"type": "string",
"pattern": "^[!-~]([ -~]){0,31}$"
},
"protocolNumber": {
"description": "Protocol number of connection capability, cannot be modified",
"type": "number",
"minimum": 0,
"maximum": 254
},
"portNumber": {
"description": "Port number of connection capability, cannot be modified",
"type": "number",
"minimum": 0,
"maximum": 65535
},
"status": {
"description": "Status of connection capability",
"enum": [
"CLOSED",
"OPEN",
"UNKNOWN"
]
}
},
"required": [
"protocolName",
"protocolNumber",
"portNumber",
"status"
]
}
},
"customConnectionCapabilities": {
"description": "Custom connection capabilities of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"protocolName": {
"description": "Protocol aame of connection capability",
"type": "string",
"pattern": "^[!-~]([ -~]){0,31}$"
},
"protocolNumber": {
"description": "Protocol number of connection capability",
"type": "number",
"minimum": 0,
"maximum": 254
},
"portNumber": {
"description": "Port number of connection capability",
"type": "number",
"minimum": 0,
"maximum": 65535
},
"status": {
"description": "Status of connection capability",
"enum": [
"CLOSED",
"OPEN",
"UNKNOWN"
]
}
},
"required": [
"protocolName",
"protocolNumber",
"portNumber",
"status"
]
}
}
}
}
204
Modify Operator ¶
PATCH/v6_1/rkszones/{zoneId}/hs20s/{id}/operator
Use this API command to modify operator profile on Hotspot 2.0 WLAN profile of a zone.
Body
{
"id": "e6373c40-8194-11e4-aa2e-000c299b4765",
"name": "operatorTEST"
}
Schema
{
"description": "Operator of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Modify Identity Providers ¶
PATCH/v6_1/rkszones/{zoneId}/hs20s/{id}/identityProviders
Use this API command to modify identity provider profiles on Hotspot 2.0 WLAN profile of a zone.
Body
[
{
"id": "9eec1055-45dd-45c5-a631-f1b76530bb67",
"name": "identityProviderDisabled"
},
{
"id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name": "identityProviderEnabled"
}
]
Schema
{
"description": "Identity providers of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
204
Modify Default Identity Provider ¶
PATCH/v6_1/rkszones/{zoneId}/hs20s/{id}/defaultIdentityProvider
Use this API command to modify the default identity provider profile on Hotspot 2.0 WLAN profile of a zone.
Body
{
"id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name": "identityProviderEnabled"
}
Schema
{
"description": "Default identity provider of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Modify Signup SSID ¶
PATCH/v6_1/rkszones/{zoneId}/hs20s/{id}/signupSsid
Use this API command to modify signup SSID on Hotspot 2.0 WLAN profile of a zone.
Body
{
"id": "1",
"name": "osenWlan"
}
Schema
{
"description": "Signup SSID of the Hotspot 2.0 WLAN profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Modify Default Connection Capabilities ¶
PATCH/v6_1/rkszones/{zoneId}/hs20s/{id}/connectionCapabilities
Use this API command to modify connection capabilities on Hotspot 2.0 WLAN profile of a zone.
Body
[
{
"protocolName": "ICMP",
"protocolNumber": 1,
"portNumber": 0,
"status": "OPEN"
},
{
"protocolName": "FTP",
"protocolNumber": 6,
"portNumber": 20,
"status": "OPEN"
},
{
"protocolName": "SSH",
"protocolNumber": 6,
"portNumber": 22,
"status": "UNKNOWN"
},
{
"protocolName": "HTTP",
"protocolNumber": 6,
"portNumber": 80,
"status": "CLOSED"
},
{
"protocolName": "Used by TLS VPN",
"protocolNumber": 6,
"portNumber": 443,
"status": "CLOSED"
},
{
"protocolName": "Used by PPTP VPNs",
"protocolNumber": 6,
"portNumber": 1723,
"status": "CLOSED"
},
{
"protocolName": "VoIP",
"protocolNumber": 6,
"portNumber": 5060,
"status": "CLOSED"
},
{
"protocolName": "VoIP",
"protocolNumber": 17,
"portNumber": 5060,
"status": "CLOSED"
},
{
"protocolName": "Used by IKEv2(IPSec VPN)",
"protocolNumber": 17,
"portNumber": 500,
"status": "CLOSED"
},
{
"protocolName": "IPSec VPN",
"protocolNumber": 17,
"portNumber": 4500,
"status": "CLOSED"
},
{
"protocolName": "ESP",
"protocolNumber": 50,
"portNumber": 0,
"status": "CLOSED"
}
]
Schema
{
"description": "Default connection capabilities of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"protocolName": {
"description": "Protocol aame of connection capability, cannot be modified",
"type": "string",
"pattern": "^[!-~]([ -~]){0,31}$"
},
"protocolNumber": {
"description": "Protocol number of connection capability, cannot be modified",
"type": "number",
"minimum": 0,
"maximum": 254
},
"portNumber": {
"description": "Port number of connection capability, cannot be modified",
"type": "number",
"minimum": 0,
"maximum": 65535
},
"status": {
"description": "Status of connection capability",
"enum": [
"CLOSED",
"OPEN",
"UNKNOWN"
]
}
},
"required": [
"protocolName",
"protocolNumber",
"portNumber",
"status"
]
}
}
204
Modify Custom Connection Capabilities ¶
PATCH/v6_1/rkszones/{zoneId}/hs20s/{id}/customConnectionCapabilities
Use this API command to modify custom connection capabilities on Hotspot 2.0 WLAN profile of a zone.
Body
[
{
"protocolName": "ICMP",
"protocolNumber": 2,
"portNumber": 0,
"status": "OPEN"
},
{
"protocolName": "FTP",
"protocolNumber": 2,
"portNumber": 20,
"status": "OPEN"
}
]
Schema
{
"description": "Custom connection capabilities of the Hotspot 2.0 WLAN profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"protocolName": {
"description": "Protocol aame of connection capability",
"type": "string",
"pattern": "^[!-~]([ -~]){0,31}$"
},
"protocolNumber": {
"description": "Protocol number of connection capability",
"type": "number",
"minimum": 0,
"maximum": 254
},
"portNumber": {
"description": "Port number of connection capability",
"type": "number",
"minimum": 0,
"maximum": 65535
},
"status": {
"description": "Status of connection capability",
"enum": [
"CLOSED",
"OPEN",
"UNKNOWN"
]
}
},
"required": [
"protocolName",
"protocolNumber",
"portNumber",
"status"
]
}
}
204
Hotspot20 Venue Service ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/hs20/venues
Use this API command to retrieve a list of Hotspot 2.0 venue profile of a zone.
200
Body
{
"totalCount": 9,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "portalName1"
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "portalName2"
},
{
"id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name": "portalName3"
},
{
"id": "7f0eef00-7423-11e4-bcef-000c299b4765",
"name": "portalName4"
},
{
"id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name": "portalName5"
},
{
"id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name": "portalName6"
},
{
"id": "afebbc80-73be-11e4-bfde-f0def13d5845",
"name": "portalName7"
},
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name": "portalName8"
},
{
"id": "96308310-752c-11e4-8276-00606eb0c700",
"name": "portalName9"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/hs20/venues/{id}
Use this API command to retrieve a Hotspot 2.0 venue profile of a zone.
200
Body
{
"name": "test-hs20Venue",
"id": "4136c9f0-7f6d-11e4-8fea-80fa5b024259",
"description": "des-hs20Venue",
"zoneId": "6b4279d6-a003-464e-9cbc-1e7ebee387c0",
"group": "UtilityAndMiscellaneous",
"type": "Unspecified",
"downlinkSpeedInKbps": 22,
"uplinkSpeedInKbps": 224,
"venueNames": [
{
"language": "English",
"name": "add friendly name"
},
{
"language": "German",
"name": "add friendly name"
},
{
"language": "Japanese",
"name": "add friendly name"
},
{
"language": "Swedish",
"name": "add friendly name"
},
{
"language": "Turkish",
"name": "add friendly name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Hotspot 2.0 venue profile",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the Hotspot 2.0 venue profile belongs to",
"type": "string"
},
"name": {
"description": "Name of the Hotspot 2.0 venue profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot 2.0 venue profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"group": {
"description": "Category group of the Hotspot 2.0 venue profile",
"enum": [
"Unspecified",
"Assembly",
"Business",
"Educational",
"FactoryAndIndustrial",
"Institutional",
"Mercantile",
"Residential",
"Storage",
"UtilityAndMiscellaneous",
"Vehicular",
"Outdoor"
]
},
"type": {
"description": "Category type of the Hotspot 2.0 venue profile",
"type": "string"
},
"downlinkSpeedInKbps": {
"description": "Link Speed of the Hotspot 2.0 venue profile",
"type": "number",
"minimum": 0,
"maximum": 4294967295
},
"uplinkSpeedInKbps": {
"description": "Link Speed of the Hotspot 2.0 venue profile",
"type": "number",
"minimum": 0,
"maximum": 4294967295
},
"venueNames": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Friendly name of venue",
"enum": [
"English",
"Chinese",
"Czech",
"Danish",
"Dutch",
"French",
"German",
"Japanese",
"Spanish",
"Korean",
"Swedish",
"Turkish",
"eng",
"chi",
"cze",
"dan",
"dut",
"fre",
"ger",
"jpn",
"kor",
"spa",
"swe",
"tur"
]
},
"name": {
"description": "Venue name",
"type": "string"
}
},
"required": [
"language",
"name"
]
}
}
}
}
Create ¶
POST/v6_1/rkszones/{zoneId}/hs20/venues
Use this API command to create a new Hotspot 2.0 venue profile of a zone.
Body
{
"name": "test-hs20Venue",
"description": "des-hs20Venue",
"group": "UtilityAndMiscellaneous",
"type": "Unspecified",
"downlinkSpeedInKbps": 22,
"uplinkSpeedInKbps": 224,
"venueNames": [
{
"language": "English",
"name": "add friendly name"
},
{
"language": "German",
"name": "add friendly name"
},
{
"language": "Japanese",
"name": "add friendly name"
},
{
"language": "Swedish",
"name": "add friendly name"
},
{
"language": "Turkish",
"name": "add friendly name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot 2.0 venue profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot 2.0 venue profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"group": {
"description": "Category group of the Hotspot 2.0 venue profile",
"enum": [
"Unspecified",
"Assembly",
"Business",
"Educational",
"FactoryAndIndustrial",
"Institutional",
"Mercantile",
"Residential",
"Storage",
"UtilityAndMiscellaneous",
"Vehicular",
"Outdoor"
]
},
"type": {
"description": "Category type of the Hotspot 2.0 venue profile",
"type": "string"
},
"downlinkSpeedInKbps": {
"description": "Link Speed of the Hotspot 2.0 venue profile",
"type": "number",
"minimum": 0,
"maximum": 4294967295
},
"uplinkSpeedInKbps": {
"description": "Link Speed of the Hotspot 2.0 venue profile",
"type": "number",
"minimum": 0,
"maximum": 4294967295
},
"venueNames": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Friendly name of venue",
"enum": [
"English",
"Chinese",
"Czech",
"Danish",
"Dutch",
"French",
"German",
"Japanese",
"Spanish",
"Korean",
"Swedish",
"Turkish",
"eng",
"chi",
"cze",
"dan",
"dut",
"fre",
"ger",
"jpn",
"kor",
"spa",
"swe",
"tur"
]
},
"name": {
"description": "Venue name",
"type": "string"
}
},
"required": [
"language",
"name"
]
}
}
},
"required": [
"name",
"venueNames"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/hs20/venues/{id}
Use this API command to modify the basic information on Hotspot 2.0 venue profile of a zone.
Body
{
"name": "test-hs20Venue-modify",
"description": "des-hs20Venue-modify",
"group": "UtilityAndMiscellaneous",
"type": "Unspecified",
"downlinkSpeedInKbps": 111111,
"uplinkSpeedInKbps": 11111,
"venueNames": [
{
"language": "English",
"name": "add friendly name"
},
{
"language": "German",
"name": "add friendly name"
},
{
"language": "Japanese",
"name": "add friendly name"
},
{
"language": "Swedish",
"name": "add friendly name"
},
{
"language": "Turkish",
"name": "add friendly name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot 2.0 venue profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot 2.0 venue profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"group": {
"description": "Category group of the Hotspot 2.0 venue profile",
"enum": [
"Unspecified",
"Assembly",
"Business",
"Educational",
"FactoryAndIndustrial",
"Institutional",
"Mercantile",
"Residential",
"Storage",
"UtilityAndMiscellaneous",
"Vehicular",
"Outdoor"
]
},
"type": {
"description": "Category type of the Hotspot 2.0 venue profile",
"type": "string"
},
"downlinkSpeedInKbps": {
"description": "Link Speed of the Hotspot 2.0 venue profile",
"type": "number",
"minimum": 0,
"maximum": 4294967295
},
"uplinkSpeedInKbps": {
"description": "Link Speed of the Hotspot 2.0 venue profile",
"type": "number",
"minimum": 0,
"maximum": 4294967295
},
"venueNames": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Friendly name of venue",
"enum": [
"English",
"Chinese",
"Czech",
"Danish",
"Dutch",
"French",
"German",
"Japanese",
"Spanish",
"Korean",
"Swedish",
"Turkish",
"eng",
"chi",
"cze",
"dan",
"dut",
"fre",
"ger",
"jpn",
"kor",
"spa",
"swe",
"tur"
]
},
"name": {
"description": "Venue name",
"type": "string"
}
},
"required": [
"language",
"name"
]
}
}
}
}
204
Modify Venue Names ¶
PATCH/v6_1/rkszones/{zoneId}/hs20/venues/{id}/venueNames
Use this API command to modify the venue names on Hotspot 2.0 venue profile of a zone.
Body
[
{
"language": "English",
"name": "add friendly name"
},
{
"language": "German",
"name": "add friendly name"
},
{
"language": "Japanese",
"name": "add friendly name"
},
{
"language": "Swedish",
"name": "add friendly name"
},
{
"language": "Turkish",
"name": "add friendly name"
}
]
Schema
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Friendly name of venue",
"enum": [
"English",
"Chinese",
"Czech",
"Danish",
"Dutch",
"French",
"German",
"Japanese",
"Spanish",
"Korean",
"Swedish",
"Turkish",
"eng",
"chi",
"cze",
"dan",
"dut",
"fre",
"ger",
"jpn",
"kor",
"spa",
"swe",
"tur"
]
},
"name": {
"description": "Venue name",
"type": "string"
}
},
"required": [
"language",
"name"
]
}
}
204
AP Usb Software Package ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/usbsoftware
Retrieve a list of AP Usb Software Package.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "0a6987e0-cedd-11e4-8148-f0def13d5845",
"name": "usbdev.tar.bz2"
},
{
"id": "6b1dc3b0-d1eb-11e4-b379-f0def13d5845",
"name": "usbdev-test.tar.bz2"
}
]
}
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 AP Usb Software Package",
"type": "string"
},
"name": {
"description": "name of AP Usb Software Package",
"type": "string"
}
}
}
}
}
}
Upload File ¶
POST/v6_1/rkszones/{zoneId}/usbsoftware
Create new AP Usb Software Package by upload file.
201
Body
{
"id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Delete ¶
DELETE/v6_1/rkszones/{zoneId}/usbsoftware/{id}
Delete specified AP Usb Software Package.
204
GET Zone Associate ¶
GET/v6_1/rkszones/{zoneId}/usbsoftware/{modelName}
Get APUsbSoftwarePackage associate with zone by model name.
200
Body
{
"id": "APUsbSoftwarePackageId",
"name": "APUsbSoftwarePackageName"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of AP Usb Software Package",
"type": "string"
},
"name": {
"description": "name of AP Usb Software Package",
"type": "string"
}
}
}
GET APGroup Associate ¶
GET/v6_1/rkszones/{zoneId}/apgroups/{id}/usbsoftware/{modelName}
Get APUsbSoftwarePackage associate with APGroup by model name.
200
Body
{
"id": "APUsbSoftwarePackageId",
"name": "APUsbSoftwarePackageName"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of AP Usb Software Package",
"type": "string"
},
"name": {
"description": "name of AP Usb Software Package",
"type": "string"
}
}
}
GET AP Associate ¶
GET/v6_1/aps/{apMac}/usbsoftware
Get APUsbSoftwarePackage associate AP by model name.
200
Body
{
"id": "APUsbSoftwarePackageId",
"name": "APUsbSoftwarePackageName"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of AP Usb Software Package",
"type": "string"
},
"name": {
"description": "name of AP Usb Software Package",
"type": "string"
}
}
}
L2 Access Control ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/l2ACL
Retrieve a list of L2 Access Control.
- 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
200
Body
{
"totalCount": 9,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "portalName1"
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "portalName2"
},
{
"id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name": "portalName3"
},
{
"id": "7f0eef00-7423-11e4-bcef-000c299b4765",
"name": "portalName4"
},
{
"id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name": "portalName5"
},
{
"id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name": "portalName6"
},
{
"id": "afebbc80-73be-11e4-bfde-f0def13d5845",
"name": "portalName7"
},
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name": "portalName8"
},
{
"id": "96308310-752c-11e4-8276-00606eb0c700",
"name": "portalName9"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/l2ACL/{id}
Retrieve an L2 Access Control.
200
Body
{
"name": "l2acl_name",
"id": "128a26b0-ab73-11e4-87f2-000c29c1611c",
"description": "l2acl_desc",
"zoneId": "f4c2fbf6-7f94-44f2-a509-5308db165891",
"restriction": "ALLOW",
"ruleMacs": [
"33:11:11:11:11:12",
"22:11:11:11:11:11"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of the L2 Access Control",
"type": "string"
},
"zoneId": {
"description": "identifier of the zone which the L2 Access Control belongs to",
"type": "string"
},
"name": {
"description": "name of the L2 Access Control",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the L2 Access Control",
"type": [
"string",
"null"
],
"maxLength": 64
},
"restriction": {
"description": "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
"enum": [
"ALLOW",
"BLOCK"
]
},
"ruleMacs": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
Create L2 Access Control ¶
POST/v6_1/rkszones/{zoneId}/l2ACL
Create a new L2 Access Control.
Body
{
"name": "l2acl_create_name",
"description": "l2acl_create_desc",
"restriction": "ALLOW",
"ruleMacs": [
"55:11:11:11:11:12",
"66:11:11:11:11:11"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "name of the L2 Access Control",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the L2 Access Control",
"type": [
"string",
"null"
],
"maxLength": 64
},
"restriction": {
"description": "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
"enum": [
"ALLOW",
"BLOCK"
]
},
"ruleMacs": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
},
"required": [
"name",
"restriction"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/l2ACL/{id}
Modify a specific L2 Access Control basic.
Body
{
"name": "l2acl_modify_name",
"description": "l2acl_modify_desc",
"restriction": "BLOCK",
"ruleMacs": [
"55:11:11:11:11:12",
"66:11:11:11:11:11"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "name of the L2 Access Control",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the L2 Access Control",
"type": [
"string",
"null"
],
"maxLength": 64
},
"restriction": {
"description": "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
"enum": [
"ALLOW",
"BLOCK"
]
},
"ruleMacs": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
204
Modify Rule Macs ¶
PATCH/v6_1/rkszones/{zoneId}/l2ACL/{id}/ruleMacs
Modify a specific L2 Access Control Rule Macs.
Body
[
"55:11:11:11:11:12",
"66:11:11:11:11:11"
]
Schema
{
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
204
Device Policy ¶
Retrieve List - Device Policy Porfile ¶
GET/v6_1/rkszones/{zoneId}/devicePolicy
Retrieve a list of Device Policy Porfiles within a zone.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "a2df9310-0ac0-11e6-9411-56847afe9799",
"name": "devicepolic-1"
},
{
"id": "c9df9310-0ac0-11e6-9411-56847afe9799",
"name": "devicepolic-2"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve - Device Policy Porfile ¶
GET/v6_1/rkszones/{zoneId}/devicePolicy/{id}
Retrieve a Device Policy Porfile.
200
Body
{
"id": "c9df9310-0ac0-11e6-9411-56847afe9799",
"name": "devicepolic-2",
"description": "devicepolicDesc",
"defaultAction": "ALLOW",
"rule": [
{
"description": "ruleOne",
"deviceType": "Windows",
"uplink": 0.1,
"downlink": 2.25,
"vlan": null,
"action": "ALLOW"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of the device policy cofig",
"type": "string"
},
"name": {
"description": "name of the device policy cofig",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the device policy cofig",
"type": [
"string",
"null"
],
"maxLength": 64
},
"defaultAction": {
"description": "defaultAction of the device policy cofig",
"enum": [
"ALLOW",
"BLOCK"
]
},
"rule": {
"type": "array",
"description": "rule of the device policy cofig",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "description of the device policy rule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"deviceType": {
"description": "deviceType of the device policy rule",
"enum": [
"Windows",
"Android",
"Apple_iOS",
"Mac_OS",
"Linux",
"VoIP",
"Gaming",
"Printers",
"BlackBerry",
"Chrome_OS"
]
},
"uplink": {
"description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75, 7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75, 9.00, 9.25, 9.50, 9.75, 10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
"type": "number",
"minimum": 0,
"maximum": 20
},
"downlink": {
"description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75, 7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75, 9.00, 9.25, 9.50, 9.75, 10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
"type": "number",
"minimum": 0,
"maximum": 20
},
"vlan": {
"description": "VLAN Members of the ethernet port profile",
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 4094
},
"action": {
"description": "defaultAction of the device policy cofig",
"enum": [
"ALLOW",
"BLOCK"
]
}
}
}
}
}
}
Create - Device Policy Porfile ¶
POST/v6_1/rkszones/{zoneId}/devicePolicy
Create a new Device Policy Porfile.
Body
{
"name": "devicepolic",
"description": "devicepolicDesc",
"defaultAction": "ALLOW"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "name of the device policy cofig",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the device policy cofig",
"type": [
"string",
"null"
],
"maxLength": 64
},
"defaultAction": {
"description": "defaultAction of the device policy cofig",
"enum": [
"ALLOW",
"BLOCK"
]
}
},
"required": [
"name",
"defaultAction"
]
}
201
Body
{
"id": "a2df9310-0ac0-11e6-9411-56847afe9799"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify - Device Policy Porfile ¶
PATCH/v6_1/rkszones/{zoneId}/devicePolicy/{id}
Modify a specific Device Policy Porfile.
Body
{
"name": "devicepolic",
"description": "devicepolicDesc",
"defaultAction": "ALLOW",
"rule": [
{
"description": "ruleOne",
"deviceType": "Windows",
"uplink": 19,
"downlink": 2.25,
"vlan": null,
"action": "ALLOW"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "name of the device policy cofig",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the device policy cofig",
"type": [
"string",
"null"
],
"maxLength": 64
},
"defaultAction": {
"description": "defaultAction of the device policy cofig",
"enum": [
"ALLOW",
"BLOCK"
]
},
"rule": {
"type": "array",
"description": "rule of the device policy cofig",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "description of the device policy rule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"deviceType": {
"description": "deviceType of the device policy rule",
"enum": [
"Windows",
"Android",
"Apple_iOS",
"Mac_OS",
"Linux",
"VoIP",
"Gaming",
"Printers",
"BlackBerry",
"Chrome_OS"
]
},
"uplink": {
"description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75, 7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75, 9.00, 9.25, 9.50, 9.75, 10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
"type": "number",
"minimum": 0,
"maximum": 20
},
"downlink": {
"description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75, 7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75, 9.00, 9.25, 9.50, 9.75, 10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
"type": "number",
"minimum": 0,
"maximum": 20
},
"vlan": {
"description": "VLAN Members of the ethernet port profile",
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 4094
},
"action": {
"description": "defaultAction of the device policy cofig",
"enum": [
"ALLOW",
"BLOCK"
]
}
}
}
}
}
}
204
Modify - Rule of Device Policy Porfile ¶
PATCH/v6_1/rkszones/{zoneId}/devicePolicy/{id}/rule
Modify Rule of Device Policy Porfile.
Body
[
{
"description": "ruleOne",
"deviceType": "Windows",
"uplink": 19,
"downlink": 2.25,
"vlan": null,
"action": "ALLOW"
}
]
Schema
{
"type": "array",
"description": "rule of the device policy cofig",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "description of the device policy rule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"deviceType": {
"description": "deviceType of the device policy rule",
"enum": [
"Windows",
"Android",
"Apple_iOS",
"Mac_OS",
"Linux",
"VoIP",
"Gaming",
"Printers",
"BlackBerry",
"Chrome_OS"
]
},
"uplink": {
"description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75, 7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75, 9.00, 9.25, 9.50, 9.75, 10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
"type": "number",
"minimum": 0,
"maximum": 20
},
"downlink": {
"description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75, 7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75, 9.00, 9.25, 9.50, 9.75, 10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
"type": "number",
"minimum": 0,
"maximum": 20
},
"vlan": {
"description": "VLAN Members of the ethernet port profile",
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 4094
},
"action": {
"description": "defaultAction of the device policy cofig",
"enum": [
"ALLOW",
"BLOCK"
]
}
}
}
}
204
Wechat ¶
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/portals/wechat
Use this API command to retrieve a list of wechat portal.
- 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
200
Body
{
"totalCount": 9,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "portalName1"
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "portalName2"
},
{
"id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name": "portalName3"
},
{
"id": "7f0eef00-7423-11e4-bcef-000c299b4765",
"name": "portalName4"
},
{
"id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name": "portalName5"
},
{
"id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name": "portalName6"
},
{
"id": "afebbc80-73be-11e4-bfde-f0def13d5845",
"name": "portalName7"
},
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name": "portalName8"
},
{
"id": "96308310-752c-11e4-8276-00606eb0c700",
"name": "portalName9"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/portals/wechat/{id}
Use this API command to retrieve wechat portal by ID.
200
Body
{
"name": "wechat_name",
"description": "wechat_desc",
"authUrl": "http://www.ruckuswireless.com",
"dnatDestination": "ruckus",
"gracePeriod": 60,
"blackList": "172.15.20.80",
"whiteList": [
"10.1.2.3",
"10.9.0.5"
],
"dnatPortMapping": [
{
"sourcePort": 80,
"destPort": 80
},
{
"sourcePort": 60,
"destPort": 60
},
{
"sourcePort": 83,
"destPort": 85
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the wechat profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the wechat profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"authUrl": {
"description": "Authentication URL of the wechat profile",
"type": "string"
},
"dnatDestination": {
"description": "DNAT destination of the wechat profile",
"type": "string"
},
"gracePeriod": {
"description": "Grace period of the wechat profile",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
},
"blackList": {
"description": "Black list of the wechat profile",
"type": "string"
},
"whiteList": {
"description": "White list of the wechat profile",
"type": "array",
"items": {
"type": "string"
}
},
"dnatPortMapping": {
"description": "DNAT Port Mapping of the wechat profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"sourcePort": {
"description": "Source port",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"destPort": {
"description": "Destination port",
"type": "integer",
"minimum": 0,
"maximum": 65535
}
}
}
}
}
}
Create ¶
POST/v6_1/rkszones/{zoneId}/portals/wechat
Use this API command to create wechat portal.
Body
{
"name": "wechat_create_name",
"description": "wechat_create_desc",
"authUrl": "http://www.ruckuswireless.com",
"dnatDestination": "ruckus",
"gracePeriod": 60,
"blackList": "172.15.20.80",
"whiteList": [
"10.1.2.3",
"10.9.0.5"
],
"dnatPortMapping": [
{
"sourcePort": 80,
"destPort": 80
},
{
"sourcePort": 60,
"destPort": 60
},
{
"sourcePort": 83,
"destPort": 85
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the wechat profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the wechat profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"authUrl": {
"description": "Authentication URL of the wechat profile",
"type": "string"
},
"dnatDestination": {
"description": "DNAT destination of the wechat profile",
"type": "string"
},
"gracePeriod": {
"description": "Grace period of the wechat profile",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
},
"blackList": {
"description": "Black list of the wechat profile",
"type": "string"
},
"whiteList": {
"description": "White list of the wechat profile",
"type": "array",
"items": {
"type": "string"
}
},
"dnatPortMapping": {
"description": "DNAT Port Mapping of the wechat profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"sourcePort": {
"description": "Source port",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"destPort": {
"description": "Destination port",
"type": "integer",
"minimum": 0,
"maximum": 65535
}
}
}
}
},
"required": [
"name",
"authUrl",
"dnatDestination",
"blackList",
"whiteList"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/portals/wechat/{id}
Use this API command to modify the basic information of wechat portal.
Body
{
"name": "wechat_modify_name",
"description": "wechat_modify_desc",
"authUrl": "http://www.ruckuswireless.com",
"dnatDestination": "ruckus",
"gracePeriod": 60,
"blackList": "172.15.20.80",
"whiteList": [
"10.1.2.3",
"10.9.0.5"
],
"dnatPortMapping": [
{
"sourcePort": 80,
"destPort": 80
},
{
"sourcePort": 60,
"destPort": 60
},
{
"sourcePort": 83,
"destPort": 85
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the wechat profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the wechat profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"authUrl": {
"description": "Authentication URL of the wechat profile",
"type": "string"
},
"dnatDestination": {
"description": "DNAT destination of the wechat profile",
"type": "string"
},
"gracePeriod": {
"description": "Grace period of the wechat profile",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
},
"blackList": {
"description": "Black list of the wechat profile",
"type": "string"
},
"whiteList": {
"description": "White list of the wechat profile",
"type": "array",
"items": {
"type": "string"
}
},
"dnatPortMapping": {
"description": "DNAT Port Mapping of the wechat profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"sourcePort": {
"description": "Source port",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"destPort": {
"description": "Destination port",
"type": "integer",
"minimum": 0,
"maximum": 65535
}
}
}
}
}
}
204
Modify DNAT Port Mapping ¶
PATCH/v6_1/rkszones/{zoneId}/portals/wechat/{id}/dnatPortMapping
Use this API command to modify DNAT port mapping of a wechat portal.
Body
[
{
"sourcePort": 80,
"destPort": 80
},
{
"sourcePort": 60,
"destPort": 60
},
{
"sourcePort": 83,
"destPort": 85
}
]
Schema
{
"description": "DNAT Port Mapping of the wechat profile",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"sourcePort": {
"description": "Source port",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"destPort": {
"description": "Destination port",
"type": "integer",
"minimum": 0,
"maximum": 65535
}
}
}
}
204
Dynamic PSK ¶
Retrieve DPSK info By Zone ¶
GET/v6_1/rkszones/{zoneId}/dpsk
Use this API command to retrieve DPSK info of a zone.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "caa96db0-5c62-4559-8c38-669f31943ca8",
"wlanId": "3",
"userName": "BatchDPSK_User_0",
"macAddress": null,
"passphrase": "zheO}VO2",
"userRoleId": null,
"vlanId": null,
"groupDpsk": false,
"creationDateTime": "2015/12/11 17:59:04",
"expirationDateTime": "2 days from first use"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"description": "Information list of DPSK",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of DPSK",
"type": "string"
},
"wlanId": {
"description": "WLAN ID of DPSK",
"type": "string"
},
"userName": {
"description": "User Name of DPSK",
"type": "string"
},
"macAddress": {
"description": "Mac address of DPSK",
"type": "string"
},
"passphrase": {
"description": "Passphrase of DPSK",
"type": "string"
},
"userRoleId": {
"description": "Identity User Role ID of DPSK",
"type": "string"
},
"vlanId": {
"description": "VLAN ID of DPSK",
"type": "integer"
},
"groupDpsk": {
"description": "Is a Group DPSK or not",
"type": "boolean"
},
"creationDateTime": {
"description": "Creationd date/time of DPSK",
"type": "number"
},
"expirationDateTime": {
"description": "Expiration date/time of DPSK",
"type": "string"
}
}
}
}
}
}
Retrieve DPSK info By WLAN ¶
GET/v6_1/rkszones/{zoneId}/wlans/{id}/dpsk
Use this API command to retrieve DPSK info of a WLAN.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "caa96db0-5c62-4559-8c38-669f31943ca8",
"wlanId": "3",
"userName": "BatchDPSK_User_0",
"macAddress": null,
"passphrase": "zheO}VO2",
"userRoleId": null,
"vlanId": null,
"groupDpsk": false,
"creationDateTime": "2015/12/11 17:59:04",
"expirationDateTime": "2 days from first use"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"description": "Information list of DPSK",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of DPSK",
"type": "string"
},
"wlanId": {
"description": "WLAN ID of DPSK",
"type": "string"
},
"userName": {
"description": "User Name of DPSK",
"type": "string"
},
"macAddress": {
"description": "Mac address of DPSK",
"type": "string"
},
"passphrase": {
"description": "Passphrase of DPSK",
"type": "string"
},
"userRoleId": {
"description": "Identity User Role ID of DPSK",
"type": "string"
},
"vlanId": {
"description": "VLAN ID of DPSK",
"type": "integer"
},
"groupDpsk": {
"description": "Is a Group DPSK or not",
"type": "boolean"
},
"creationDateTime": {
"description": "Creationd date/time of DPSK",
"type": "number"
},
"expirationDateTime": {
"description": "Expiration date/time of DPSK",
"type": "string"
}
}
}
}
}
}
Retrieve DPSK info By Id ¶
GET/v6_1/rkszones/{zoneId}/wlans/{id}/dpsk/{dpskId}
Use this API command to retrieve DPSK info.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "caa96db0-5c62-4559-8c38-669f31943ca8",
"wlanId": "3",
"userName": "BatchDPSK_User_0",
"macAddress": null,
"passphrase": "zheO}VO2",
"userRoleId": null,
"vlanId": null,
"groupDpsk": false,
"creationDateTime": "2015/12/11 17:59:04",
"expirationDateTime": "2 days from first use"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"description": "Information list of DPSK",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of DPSK",
"type": "string"
},
"wlanId": {
"description": "WLAN ID of DPSK",
"type": "string"
},
"userName": {
"description": "User Name of DPSK",
"type": "string"
},
"macAddress": {
"description": "Mac address of DPSK",
"type": "string"
},
"passphrase": {
"description": "Passphrase of DPSK",
"type": "string"
},
"userRoleId": {
"description": "Identity User Role ID of DPSK",
"type": "string"
},
"vlanId": {
"description": "VLAN ID of DPSK",
"type": "integer"
},
"groupDpsk": {
"description": "Is a Group DPSK or not",
"type": "boolean"
},
"creationDateTime": {
"description": "Creationd date/time of DPSK",
"type": "number"
},
"expirationDateTime": {
"description": "Expiration date/time of DPSK",
"type": "string"
}
}
}
}
}
}
Upload DPSK file ¶
POST/v6_1/rkszones/{zoneId}/wlans/{id}/dpsk/upload
Use this API command to upload DPSK file of a WLAN (CSV file is only accepted).
201
Body
{
"resultCount": 2,
"dpskInfoList": [
{
"id": "5da5b9e9-78de-46f5-8d73-b0b7ac8abd37",
"wlanId": "1",
"userName": "student_0",
"macAddress": null,
"passphrase": "passphrase01",
"userRoleId": "2759b0b3-0a40-455d-a061-e43072c334e5",
"vlanId": 3,
"groupDpsk": true,
"creationDateTime": "2015/12/11 17:59:04",
"expirationDateTime": "2 days from first use"
},
{
"id": "6af7ec03-d853-4485-88e2-48d503c836b4",
"wlanId": "1",
"userName": "student_1",
"macAddress": null,
"passphrase": "passphrase02",
"userRoleId": "2759b0b3-0a40-455d-a061-e43072c334e5",
"vlanId": 3,
"groupDpsk": true,
"creationDateTime": "2015/12/11 17:59:04",
"expirationDateTime": "2 days from first use"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"resultCount": {
"type": "integer"
},
"dpskInfoList": {
"description": "Information list of DPSK",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of DPSK",
"type": "string"
},
"wlanId": {
"description": "WLAN ID of DPSK",
"type": "string"
},
"userName": {
"description": "User Name of DPSK",
"type": "string"
},
"macAddress": {
"description": "Mac address of DPSK",
"type": "string"
},
"passphrase": {
"description": "Passphrase of DPSK",
"type": "string"
},
"userRoleId": {
"description": "Identity User Role ID of DPSK",
"type": "string"
},
"vlanId": {
"description": "VLAN ID of DPSK",
"type": "integer"
},
"groupDpsk": {
"description": "Is a Group DPSK or not",
"type": "boolean"
},
"creationDateTime": {
"description": "Creationd date/time of DPSK",
"type": "number"
},
"expirationDateTime": {
"description": "Expiration date/time of DPSK",
"type": "string"
}
}
}
}
}
}
Batch Generate DPSKs ¶
POST/v6_1/rkszones/{zoneId}/wlans/{id}/dpsk/batchGenUnbound
Use this API command to batch generate DPSKs of a WLAN. You can either specify passphrases or not. If the amount is bigger than 1, system will generate usernames with index. e.g. student-1, student-2, …etc.
Body
‧ Sample : Batch generate DPSK with randomly passphrase(s)
{
"amount" : 2,
"userName" : "student",
"userRoleId" : "2759b0b3-0a40-455d-a061-e43072c334e5",
"vlanId" : 3,
"groupDpsk" : true
}
‧ Sample : Batch generate DPSK with specified passphrase(s)
{
"userName" : "student",
"passphraseList" : [ "passphrase01", "passphrase02" ],
"userRoleId" : "2759b0b3-0a40-455d-a061-e43072c334e5",
"vlanId" : 3,
"groupDpsk" : true
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "Amount of generate unbound DPSK",
"type" : "integer"
},
"userName" : {
"description" : "User Name of DPSK",
"type" : "string"
},
"passphraseList" : {
"type" : "array",
"items" : {
"description" : "Generate DPSK with specific passphrase list",
"type" : "string"
}
},
"userRoleId" : {
"description" : "Identity User Role ID of DPSK",
"type" : "string"
},
"vlanId" : {
"description" : "VLAN ID of DPSK",
"type" : "integer"
},
"groupDpsk" : {
"description" : "Using group DPSK or not",
"type" : "boolean"
}
}
}
201
Body
{
"resultCount": 2,
"dpskInfoList": [
{
"id": "5da5b9e9-78de-46f5-8d73-b0b7ac8abd37",
"wlanId": "1",
"userName": "student_0",
"macAddress": null,
"passphrase": "passphrase01",
"userRoleId": "2759b0b3-0a40-455d-a061-e43072c334e5",
"vlanId": 3,
"groupDpsk": true,
"creationDateTime": "2015/12/11 17:59:04",
"expirationDateTime": "2 days from first use"
},
{
"id": "6af7ec03-d853-4485-88e2-48d503c836b4",
"wlanId": "1",
"userName": "student_1",
"macAddress": null,
"passphrase": "passphrase02",
"userRoleId": "2759b0b3-0a40-455d-a061-e43072c334e5",
"vlanId": 3,
"groupDpsk": true,
"creationDateTime": "2015/12/11 17:59:04",
"expirationDateTime": "2 days from first use"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"resultCount": {
"type": "integer"
},
"dpskInfoList": {
"description": "Information list of DPSK",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of DPSK",
"type": "string"
},
"wlanId": {
"description": "WLAN ID of DPSK",
"type": "string"
},
"userName": {
"description": "User Name of DPSK",
"type": "string"
},
"macAddress": {
"description": "Mac address of DPSK",
"type": "string"
},
"passphrase": {
"description": "Passphrase of DPSK",
"type": "string"
},
"userRoleId": {
"description": "Identity User Role ID of DPSK",
"type": "string"
},
"vlanId": {
"description": "VLAN ID of DPSK",
"type": "integer"
},
"groupDpsk": {
"description": "Is a Group DPSK or not",
"type": "boolean"
},
"creationDateTime": {
"description": "Creationd date/time of DPSK",
"type": "number"
},
"expirationDateTime": {
"description": "Expiration date/time of DPSK",
"type": "string"
}
}
}
}
}
}
Retrieve interval of delete expired DPSK ¶
GET/v6_1/rkszones/{zoneId}/deleteExpiredDpsk
Use this API command to retrieve interval of delete expired DPSK of a zone.
200
Body
{
"deleteExpiredDpsk": "Never"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"deleteExpiredDpsk": {
"description": "Delete expired DPSK interval of the Zone.",
"enum": [
"Never",
"AfterOneDay",
"AfterSixMonths"
]
}
}
}
Modify interval of delete expired DPSK ¶
PUT/v6_1/rkszones/{zoneId}/deleteExpiredDpsk
Use this API command to modify interval of delete expired DPSK of a zone.
Body
{
"deleteExpiredDpsk": "AfterOneDay"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"deleteExpiredDpsk": {
"description": "Delete expired DPSK interval of the Zone.",
"enum": [
"Never",
"AfterOneDay",
"AfterSixMonths"
]
}
}
}
204
Delete DPSK ¶
POST/v6_1/rkszones/{zoneId}/wlans/{id}/dpsk
Use this API command to delete DPSKs of a WLAN.
Body
{
"idList": [
"fb357b53-48dd-4a23-b6bf-2e3d935d8df3",
"c2074deb-0f0c-47fa-bf56-f3f2f5b64de0"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"description": "Id list of DPSK",
"type": "string"
}
}
}
}
200
Body
{
"resultCount": 2
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"resultCount": {
"type": "integer"
}
}
}
Update DPSK info By Id ¶
PATCH/v6_1/rkszones/{zoneId}/wlans/{id}/dpsk/{dpskId}
Use this API command to update DPSK info.
Body
{
"userName": "updateUserName01"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"userName": {
"description": "User Name of DPSK",
"type": "string"
}
}
}
204
Retrieve DPSK Enabled WLAN info By Zone. ¶
GET/v6_1/rkszones/{zoneId}/dpskEnabledWlans
Use this API command to retrieve DPSK enabled WLAN info of a zone.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"wlanId": "1",
"ssid": "ssid1",
"wlanName": "DpskWlan1"
},
{
"wlanId": "2",
"ssid": "ssid2",
"wlanName": "DpskWlan2"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total DPSK enabled WLAN count of the zone",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more DPSK enabled WLANs after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first DPSK enabled WLAN returned out of the complete WLAN list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"wlanId": {
"description": "Identifier of the DPSK enabled WLAN",
"type": "string"
},
"ssid": {
"description": "SSID of the DPSK enabled WLAN",
"type": "string"
},
"wlanName": {
"description": "Name of the the DPSK enabled WLAN",
"type": "string"
}
}
}
}
}
}
DiffServ ¶
Retrieve list ¶
GET/v6_1/rkszones/{zoneId}/diffserv
Use this API command to retrieve a list of DiffServ profile.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "510d26e1-05fd-11e6-bfc2-5254002b8a65",
"name": "DiffServ name 1"
},
{
"id": "556a6be0-0610-11e6-9de9-bad3cba0b410",
"name": "DiffServ name 2"
}
]
}
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 diff serv",
"type": "string"
},
"name": {
"description": "Name of the diff serv",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/diffserv/{id}
Use this API command to retrieve DiffServ profile.
200
Body
{
"name": "DiffServ name",
"description": "DiffServ description",
"uplinkDiffServ": {
"uplinkEnable": true,
"uplink": "80"
},
"downlinkDiffServ": {
"downlinkEnable": true,
"downlink": "90"
},
"preservedList": [
"20",
"21",
"22",
"23",
"24",
"26"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the zone",
"type": "string"
},
"name": {
"description": "Name of the diffserv",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the diffserv",
"type": [
"string",
"null"
],
"maxLength": 64
},
"uplinkDiffServ": {
"description": "Tunnel DiffServ - Set Uplink Diffserv",
"type": "object",
"additionalProperties": false,
"properties": {
"uplinkEnable": {
"description": "Uplink enable",
"type": "boolean"
},
"uplink": {
"description": "Uplink",
"type": "string"
}
}
},
"downlinkDiffServ": {
"description": "Tunnel DiffServ - Set Downlink Diffserv",
"type": "object",
"additionalProperties": false,
"properties": {
"downlinkEnable": {
"description": "Downlink enable",
"type": "boolean"
},
"downlink": {
"description": "Downlink",
"type": "string"
}
}
},
"preservedList": {
"type": "array",
"description": "Preserved list",
"items": {
"type": "string"
}
}
}
}
Create ¶
POST/v6_1/rkszones/{zoneId}/diffserv
Use this API command to create DiffServ profile.
Body
{
"name": "DiffServ name",
"description": "DiffServ description",
"uplinkDiffServ": {
"uplinkEnable": true,
"uplink": "80"
},
"downlinkDiffServ": {
"downlinkEnable": true,
"downlink": "90"
},
"preservedList": [
"20",
"21",
"22",
"23",
"24",
"26"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the diffserv",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the diffserv",
"type": [
"string",
"null"
],
"maxLength": 64
},
"uplinkDiffServ": {
"description": "Tunnel DiffServ - Set Uplink Diffserv",
"type": "object",
"additionalProperties": false,
"properties": {
"uplinkEnable": {
"description": "Uplink enable",
"type": "boolean"
},
"uplink": {
"description": "Uplink",
"type": "string"
}
}
},
"downlinkDiffServ": {
"description": "Tunnel DiffServ - Set Downlink Diffserv",
"type": "object",
"additionalProperties": false,
"properties": {
"downlinkEnable": {
"description": "Downlink enable",
"type": "boolean"
},
"downlink": {
"description": "Downlink",
"type": "string"
}
}
},
"preservedList": {
"type": "array",
"description": "Preserved list",
"items": {
"type": "string"
}
}
},
"required": [
"name"
]
}
201
Body
{
"id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/diffserv/{id}
Use this API command to modify the basic information of DiffServ profile.
Body
{
"name": "DiffServ name",
"description": "DiffServ description",
"uplinkDiffServ": {
"uplinkEnable": true,
"uplink": "80"
},
"downlinkDiffServ": {
"downlinkEnable": true,
"downlink": "90"
},
"preservedList": [
"20",
"21",
"22",
"23",
"24",
"26"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the diffserv",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the diffserv",
"type": [
"string",
"null"
],
"maxLength": 64
},
"uplinkDiffServ": {
"description": "Tunnel DiffServ - Set Uplink Diffserv",
"type": "object",
"additionalProperties": false,
"properties": {
"uplinkEnable": {
"description": "Uplink enable",
"type": "boolean"
},
"uplink": {
"description": "Uplink",
"type": "string"
}
}
},
"downlinkDiffServ": {
"description": "Tunnel DiffServ - Set Downlink Diffserv",
"type": "object",
"additionalProperties": false,
"properties": {
"downlinkEnable": {
"description": "Downlink enable",
"type": "boolean"
},
"downlink": {
"description": "Downlink",
"type": "string"
}
}
},
"preservedList": {
"type": "array",
"description": "Preserved list",
"items": {
"type": "string"
}
}
},
"required": [
"name"
]
}
204
Modify Uplink DiffServ ¶
PATCH/v6_1/rkszones/{zoneId}/diffserv/{id}/uplinkDiffServ
Use this API command to modify uplink diffserv.
Body
{
"uplinkEnable": true,
"uplink": "80"
}
Schema
{
"description": "Tunnel DiffServ - Set Uplink Diffserv",
"type": "object",
"additionalProperties": false,
"properties": {
"uplinkEnable": {
"description": "Uplink enable",
"type": "boolean"
},
"uplink": {
"description": "Uplink",
"type": "string"
}
}
}
204
Modify Downlink DiffServ ¶
PATCH/v6_1/rkszones/{zoneId}/diffserv/{id}/downlinkDiffServ
Use this API command to modify downlink diffserv.
Body
{
"downlinkEnable": true,
"downlink": "90"
}
Schema
{
"description": "Tunnel DiffServ - Set Downlink Diffserv",
"type": "object",
"additionalProperties": false,
"properties": {
"downlinkEnable": {
"description": "Downlink enable",
"type": "boolean"
},
"downlink": {
"description": "Downlink",
"type": "string"
}
}
}
204
DHCP ¶
Create DHCP Pool ¶
POST/v6_1/rkszones/{zoneId}/dhcpSite/dhcpProfile
Use this API command to create DHCP Pool.
Body
{
"name": "dhcp profile-test",
"description": "create description",
"vlanId": 30,
"subnetNetworkIp": "10.2.2.0",
"subnetMask": "255.255.255.0",
"poolStartIp": "10.2.2.1",
"poolEndIp": "10.2.2.254",
"primaryDnsIp": "2.2.2.2",
"secondaryDnsIp": "8.8.8.8",
"leaseTimeHours": 12,
"leaseTimeMinutes": 30
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 2,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
},
"required": [
"name",
"vlanId",
"subnetNetworkIp",
"subnetMask",
"poolStartIp",
"poolEndIp",
"leaseTimeHours",
"leaseTimeMinutes"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Get DHCP Pool by Pool's ID ¶
GET/v6_1/rkszones/{zoneId}/dhcpSite/dhcpProfile/{id}
Use this API command to get DHCP Pool by pool’s ID.
200
Body
{
"id": "75e26590-547f-11e6-9ca7-5a095364c13c",
"name": "dppf_01",
"description": "dppf_01",
"vlanId": 10,
"subnetNetworkIp": "10.2.2.0",
"subnetMask": "255.255.255.0",
"poolStartIp": "10.2.2.1",
"poolEndIp": "10.2.2.254",
"primaryDnsIp": "2.2.2.2",
"secondaryDnsIp": "8.8.8.8",
"leaseTimeHours": 24,
"leaseTimeMinutes": 0
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 2,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
Get DHCP Pool list ¶
GET/v6_1/rkszones/{zoneId}/dhcpSite/dhcpProfile
Use this API command to get DHCP Pool list.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "75e26590-547f-11e6-9ca7-5a095364c13c",
"name": "dppf_01",
"description": "dppf_01",
"vlanId": 10,
"subnetNetworkIp": "10.2.2.0",
"subnetMask": "255.255.255.0",
"poolStartIp": "10.2.2.1",
"poolEndIp": "10.2.2.254",
"primaryDnsIp": "2.2.2.2",
"secondaryDnsIp": "8.8.8.8",
"leaseTimeHours": 24,
"leaseTimeMinutes": 0
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 2,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Get DHCP Configuration ¶
GET/v6_1/rkszones/{zoneId}/dhcpSite/dhcpSiteConfig
Use this API command to get DHCP Configuration.
200
Body
{
"zoneName": "zoneK",
"siteEnabled": true,
"manualSelect": true,
"siteMode": "EnableOnMultipleAPs",
"siteAps": [
{
"apMac": "38:FF:36:00:0E:20",
"apServerEnabled": true,
"apGatewayEnabled": true
},
{
"apMac": "58:FF:36:00:0E:20",
"apServerEnabled": true,
"apGatewayEnabled": true
}
],
"siteProfiles": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
}
Schema
{
"description": "DHCP Site Configuration in Zone",
"type": "object",
"additionalProperties": false,
"properties": {
"zoneName": {
"description": "DHCP Service Zone Name",
"type": "string"
},
"siteEnabled": {
"description": "DHCP Service Enabling Status",
"type": "boolean"
},
"manualSelect": {
"description": "DHCP Service AP Selection Mode",
"type": "boolean"
},
"siteMode": {
"description": "DHCP Service mode",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs"
]
},
"siteAps": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Site selected APs",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"apStatus": {
"enum": [
"Online",
"Offline",
"Flagged"
]
},
"apServerEnabled": {
"type": "boolean"
},
"apServerPrimary": {
"type": "boolean"
},
"apServerIp": {
"type": "string"
},
"apGatewayIp": {
"type": "string"
}
}
}
},
"siteProfiles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 2,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
}
}
}
Get AP DHCP Pools Usage. ¶
GET/v6_1/dhcpData/dhcpPools/{apMac}
Use this API command to get AP DHCP Pools Usage.
200
Body
{
"id": null,
"tenantId": null,
"domainId": null,
"domainEntity": null,
"apMac": "F6-59-42-EF-AE-5E",
"poolInfoList": [
{
"poolIndex": "0",
"vlanId": "10",
"namd": "Pool10",
"poolStartIp": "192.168.10.1",
"poolEndIp": "192.168.10.100",
"subnetMask": "255.255.255.0",
"apIp": "192.168.10.1",
"totalIpCount": 90,
"usedIpCount": 3,
"availableIpCount": 87,
"clientInfoList": {
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"clientMac": "A2-17-56-E1-F4-EA",
"clientIp": "192.168.10.11",
"leaseTime": 300,
"leaseTimeHours": 0,
"leaseTimeMinutes": 5,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "A2-B5-87-DF-AC-98",
"clientIp": "192.168.10.12",
"leaseTime": 3600,
"leaseTimeHours": 1,
"leaseTimeMinutes": 0,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "A2-3D-62-15-8A-ED",
"clientIp": "192.168.10.13",
"leaseTime": 360,
"leaseTimeHours": 0,
"leaseTimeMinutes": 6,
"leaseExpirtyTime": 1483016168
}
]
}
},
{
"poolIndex": "1",
"vlanId": "20",
"namd": "Pool20",
"poolStartIp": "192.168.20.1",
"poolEndIp": "192.168.20.100",
"subnetMask": "255.255.255.0",
"apIp": "192.168.20.1",
"totalIpCount": 90,
"usedIpCount": 3,
"availableIpCount": 87,
"clientInfoList": {
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"clientMac": "B2-8B-07-26-D5-8E",
"clientIp": "192.168.20.11",
"leaseTime": 300,
"leaseTimeHours": 0,
"leaseTimeMinutes": 5,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "B2-13-A0-66-36-A0",
"clientIp": "192.168.20.12",
"leaseTime": 3600,
"leaseTimeHours": 1,
"leaseTimeMinutes": 0,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "B2-6A-C8-EA-3D-E1",
"clientIp": "192.168.20.13",
"leaseTime": 360,
"leaseTimeHours": 0,
"leaseTimeMinutes": 6,
"leaseExpirtyTime": 1483016168
}
]
}
},
{
"poolIndex": "2",
"vlanId": "30",
"namd": "Pool30",
"poolStartIp": "192.168.30.1",
"poolEndIp": "192.168.30.100",
"subnetMask": "255.255.255.0",
"apIp": "192.168.30.1",
"totalIpCount": 90,
"usedIpCount": 3,
"availableIpCount": 87,
"clientInfoList": {
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"clientMac": "C2-38-C5-43-52-EA",
"clientIp": "192.168.30.11",
"leaseTime": 300,
"leaseTimeHours": 0,
"leaseTimeMinutes": 5,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "C2-09-06-47-D1-14",
"clientIp": "192.168.30.12",
"leaseTime": 3600,
"leaseTimeHours": 1,
"leaseTimeMinutes": 0,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "C2-6B-8B-50-07-7B",
"clientIp": "192.168.30.13",
"leaseTime": 360,
"leaseTimeHours": 0,
"leaseTimeMinutes": 6,
"leaseExpirtyTime": 1483016168
}
]
}
},
{
"poolIndex": "3",
"vlanId": "40",
"namd": "Pool40",
"poolStartIp": "192.168.40.1",
"poolEndIp": "192.168.40.100",
"subnetMask": "255.255.255.0",
"apIp": "192.168.40.1",
"totalIpCount": 90,
"usedIpCount": 3,
"availableIpCount": 87,
"clientInfoList": {
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"clientMac": "D2-C7-1B-FD-B0-C0",
"clientIp": "192.168.40.11",
"leaseTime": 300,
"leaseTimeHours": 0,
"leaseTimeMinutes": 5,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "D2-CB-C3-26-75-3E",
"clientIp": "192.168.40.12",
"leaseTime": 3600,
"leaseTimeHours": 1,
"leaseTimeMinutes": 0,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "D2-DE-89-23-EB-03",
"clientIp": "192.168.40.13",
"leaseTime": 360,
"leaseTimeHours": 0,
"leaseTimeMinutes": 6,
"leaseExpirtyTime": 1483016168
}
]
}
}
]
}
Schema
{
"type": "object",
"description": "DHCP Pools Usage Per AP",
"additionalProperties": false,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"tenantId": {
"type": [
"string",
"null"
]
},
"domainId": {
"type": [
"string",
"null"
]
},
"domainEntity": {
"type": [
"string",
"null"
]
},
"apMac": {
"type": "string"
},
"poolInfoList": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Pool Information List",
"additionalProperties": false,
"properties": {
"poolIndex": {
"type": "integer"
},
"vlanId": {
"type": "integer"
},
"name": {
"type": "string"
},
"poolStartIp": {
"type": "string"
},
"poolEndIp": {
"type": "string"
},
"subnetMask": {
"type": "string"
},
"apIp": {
"type": "string"
},
"totalIpCount": {
"type": "integer"
},
"usedIpCount": {
"type": "integer"
},
"availableIpCount": {
"type": "integer"
},
"clientInfoList": {
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Pool Client Information List",
"additionalProperties": false,
"properties": {
"clientMac": {
"type": "string"
},
"clientIp": {
"type": "string"
},
"leaseTime": {
"type": "integer"
},
"leaseTimeHours": {
"type": "integer"
},
"leaseTimeMinutes": {
"type": "integer"
},
"leaseExpiryTime": {
"type": "integer"
}
}
}
}
}
}
}
}
}
}
}
Get AP DHCP Pool Usage by pool's index. ¶
GET/v6_1/dhcpData/dhcpPools/{apMac}/{poolIndex}
Use this API command to get AP DHCP Pool Usage by pool’s index.
200
Body
{
"poolIndex": "0",
"vlanId": "80",
"namd": "Pool80",
"poolStartIp": "192.168.80.1",
"poolEndIp": "192.168.80.100",
"subnetMask": "255.255.255.0",
"apIp": "192.168.80.1",
"totalIpCount": 90,
"usedIpCount": 3,
"availableIpCount": 87,
"clientInfoList": {
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"clientMac": "E2-EE-95-D4-2B-A7",
"clientIp": "192.168.80.11",
"leaseTime": 300,
"leaseTimeHours": 0,
"leaseTimeMinutes": 5,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "E2-E7-65-C5-07-C5",
"clientIp": "192.168.80.12",
"leaseTime": 3600,
"leaseTimeHours": 1,
"leaseTimeMinutes": 0,
"leaseExpirtyTime": 1483016168
},
{
"clientMac": "E2-9A-BD-A5-4A-F6",
"clientIp": "192.168.80.13",
"leaseTime": 360,
"leaseTimeHours": 0,
"leaseTimeMinutes": 6,
"leaseExpirtyTime": 1483016168
}
]
}
}
Schema
{
"type": "object",
"description": "DHCP Pool Information List",
"additionalProperties": false,
"properties": {
"poolIndex": {
"type": "integer"
},
"vlanId": {
"type": "integer"
},
"name": {
"type": "string"
},
"poolStartIp": {
"type": "string"
},
"poolEndIp": {
"type": "string"
},
"subnetMask": {
"type": "string"
},
"apIp": {
"type": "string"
},
"totalIpCount": {
"type": "integer"
},
"usedIpCount": {
"type": "integer"
},
"availableIpCount": {
"type": "integer"
},
"clientInfoList": {
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Pool Client Information List",
"additionalProperties": false,
"properties": {
"clientMac": {
"type": "string"
},
"clientIp": {
"type": "string"
},
"leaseTime": {
"type": "integer"
},
"leaseTimeHours": {
"type": "integer"
},
"leaseTimeMinutes": {
"type": "integer"
},
"leaseExpiryTime": {
"type": "integer"
}
}
}
}
}
}
}
}
Get AP DHCP Message Statistic Usage. ¶
GET/v6_1/dhcpData/dhcpMsgStats/{apMac}
Use this API command to get AP DHCP Message Statistic.
200
Body
{
"id": "9c385e78-3edd-4833-b147-370e55801331",
"tenantId": "38d7120d-bd8c-4bdf-9b9e-075e8b194d7b",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"apMac": "EC:8C:A2:01:C5:B0",
"dhcpMsgRecvdStats": {
"dhcpDiscover": 20500,
"dhcpRequest": 0,
"dhcpDecline": 650,
"dhcpRelease": 33280,
"dhcpInform": 23510
},
"dhcpMsgSentStats": {
"dhcpOffer": 20800,
"dhcpAck": 665008,
"dhcpNak": 252
}
}
Schema
{
"type": "object",
"description": "DHCP Message Statistic Per AP",
"additionalProperties": false,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"tenantId": {
"type": [
"string",
"null"
]
},
"domainId": {
"type": [
"string",
"null"
]
},
"apMac": {
"type": "string"
},
"dhcpMsgRecvdStats": {
"type": "object",
"description": "DHCP Message Received Statistic",
"additionalProperties": false,
"properties": {
"dhcpDiscover": {
"type": "integer"
},
"dhcpRequest": {
"type": "integer"
},
"dhcpDecline": {
"type": "integer"
},
"dhcpRelease": {
"type": "integer"
},
"dhcpInform": {
"type": "integer"
}
}
},
"dhcpMsgSentStats": {
"type": "object",
"description": "DHCP Message Sent Statistic",
"additionalProperties": false,
"properties": {
"dhcpOffer": {
"type": "integer"
},
"dhcpAck": {
"type": "integer"
},
"dhcpNak": {
"type": "integer"
}
}
}
}
}
Modify DHCP Profile by pool's ID ¶
PATCH/v6_1/rkszones/{zoneId}/dhcpSite/dhcpProfile/{id}
Use this API command to modify DHCP Pool by pool’s ID.
Body
{
"name": "dhcp profile-test",
"description": "create description",
"vlanId": 30,
"subnetNetworkIp": "10.2.2.0",
"subnetMask": "255.255.255.0",
"poolStartIp": "10.2.2.1",
"poolEndIp": "10.2.2.254",
"primaryDnsIp": "2.2.2.2",
"secondaryDnsIp": "8.8.8.8",
"leaseTimeHours": 12,
"leaseTimeMinutes": 30
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 2,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
},
"required": [
"name",
"vlanId",
"subnetNetworkIp",
"subnetMask",
"poolStartIp",
"poolEndIp",
"leaseTimeHours",
"leaseTimeMinutes"
]
}
204
Delete DHCP Pool by pool's ID ¶
DELETE/v6_1/rkszones/{zoneId}/dhcpSite/dhcpProfile/{id}
Use this API command to delete DHCP Pool by pool’s ID.
204
Delete multiple DHCP Pools ¶
DELETE/v6_1/rkszones/{zoneId}/dhcpSite/dhcpProfile
Use this API command to delete multiple DHCP Pools.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Bonjour Gateway Policies ¶
Retrieve list ¶
GET/v5_1/rkszones/{zoneId}/bounjourGateway/policies
Use this API command to retrieve a list of bonjour gateway policies.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "510d26e1-05fd-11e6-bfc2-5254002b8a65",
"name": "Bonjour gateway policy name 1",
"description": "Bonjour gateway policy description",
"lastModifiedBy": "user name",
"lastModifiedOn": "2016/07/12 14:38:43"
},
{
"id": "556a6be0-0610-11e6-9de9-bad3cba0b410",
"name": "Bonjour gateway policy name 2",
"description": "Bonjour gateway policy description",
"lastModifiedBy": "user name",
"lastModifiedOn": "2016/07/12 14:38:43"
}
]
}
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 bonjour gateway policy",
"type": "string"
},
"name": {
"description": "Name of the bonjour gateway policy",
"type": "string"
},
"description": {
"description": "Description of the bonjour gateway policy",
"type": "string"
},
"lastModifiedBy": {
"description": "Last modified user of the bonjour gateway policy",
"type": "string"
},
"lastModifiedOn": {
"description": "Last modified time of the bonjour gateway policy",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v5_1/rkszones/{zoneId}/bounjourGateway/policies/{id}
Use this API command to retrieve bonjour gateway policy.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
200
Body
{
"name": "bonjour gateway policy name",
"description": "bonjour gateway policy description",
"bonjourPolicyRuleList": [
{
"priority": 1,
"bridgeService": "AIRPLAY",
"fromVlan": 15,
"toVlan": 26,
"notes": "notes"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Bonjour Gateway Policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bonjour Gateway Policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"bonjourPolicyRuleList": {
"type": "array",
"description": "Bonjour policy rule list",
"items": {
"type": "object",
"description": "Bonjour policy rule",
"additionalProperties": false,
"properties": {
"priority": {
"description": "Priority",
"type": "string"
},
"bridgeService": {
"description": "Bridge service",
"type": "string"
},
"protocol": {
"description": "protocol",
"type": "string"
},
"fromVlan": {
"description": "From VLAN",
"type": "integer"
},
"toVlan": {
"description": "To VLAN",
"type": "integer"
},
"notes": {
"description": "Notes",
"type": "string",
"maximum": 180
}
}
}
}
}
}
Create ¶
POST/v5_1/rkszones/{zoneId}/bounjourGateway/policies
Use this API command to create bonjour gateway policy.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
Body
{
"name": "bonjour gateway policy name",
"description": "bonjour gateway policy description",
"bonjourPolicyRuleList": [
{
"bridgeService": "ITUNES_REMOTE",
"fromVlan": 1,
"toVlan": 10,
"notes": "notes"
}
]
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the Bonjour Gateway Policy",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Bonjour Gateway Policy",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bonjourPolicyRuleList" : {
"type" : "array",
"description" : "Bonjour policy rule list",
"items" : {
"type" : "object",
"description" : "Bonjour policy rule",
"additionalProperties" : false,
"properties" : {
"bridgeService" : {
"description" : "Bridge service",
"enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "OTHER" ]
},
"protocol" : {
"description" : "protocol. This is only available when bridgeService is OTHER",
"type" : "string",
"pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
},
"fromVlan" : {
"description" : "From VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"toVlan" : {
"description" : "To VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"notes" : {
"description" : "Notes",
"type" : "string",
"maximum" : 180
}
},
"required" : [ "bridgeService", "fromVlan", "toVlan" ]
}
}
},
"required" : [ "name" ]
}
201
Body
{
"id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify ¶
PATCH/v5_1/rkszones/{zoneId}/bounjourGateway/policies/{id}
Use this API command to modify the basic information of bonjour gateway policy.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
Body
{
"name": "bonjour gateway policy name",
"description": "bonjour gateway policy description",
"bonjourPolicyRuleList": [
{
"bridgeService": "AIRPLAY",
"fromVlan": 15,
"toVlan": 26,
"notes": "notes"
}
]
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the Bonjour Gateway Policy",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Bonjour Gateway Policy",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bonjourPolicyRuleList" : {
"type" : "array",
"description" : "Bonjour policy rule list",
"items" : {
"type" : "object",
"description" : "Bonjour policy rule",
"additionalProperties" : false,
"properties" : {
"bridgeService" : {
"description" : "Bridge service",
"enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "OTHER" ]
},
"protocol" : {
"description" : "protocol. This is only available when bridgeService is OTHER",
"type" : "string",
"pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
},
"fromVlan" : {
"description" : "From VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"toVlan" : {
"description" : "To VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"notes" : {
"description" : "Notes",
"type" : "string",
"maximum" : 180
}
},
"required" : [ "bridgeService", "fromVlan", "toVlan" ]
}
}
}
}
204
Modify bonjour gateway policy rule list ¶
PATCH/v5_1/rkszones/{zoneId}/bounjourGateway/policies/{id}/bonjourPolicyRuleList
Use this API command to modify bonjour gateway policy rules.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
Body
[
{
"bridgeService": "AIRPLAY",
"fromVlan": 15,
"toVlan": 26,
"notes": "notes"
}
]
Schema
{
"type" : "array",
"description" : "Bonjour policy rule list",
"items" : {
"type" : "object",
"description" : "Bonjour policy rule",
"additionalProperties" : false,
"properties" : {
"bridgeService" : {
"description" : "Bridge service",
"enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "OTHER" ]
},
"protocol" : {
"description" : "protocol. This is only available when bridgeService is OTHER",
"type" : "string",
"pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
},
"fromVlan" : {
"description" : "From VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"toVlan" : {
"description" : "To VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"notes" : {
"description" : "Notes",
"type" : "string",
"maximum" : 180
}
},
"required" : [ "bridgeService", "fromVlan", "toVlan" ]
}
}
204
Modify Enable ¶
PATCH/v5_1/rkszones/{zoneId}/bounjourGateway/enable
Use this API command to enable/disable bonjour gateway policy.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
Body
{
"enabledBonjourGateway": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enabledBonjourGateway": {
"description": "Enable Bonjour gateway on th AP",
"type": "boolean"
}
},
"required": [
"enabledBonjourGateway"
]
}
204
Delete ¶
DELETE/v5_1/rkszones/{zoneId}/bounjourGateway/policies/{id}
Use this API command to delete bonjour gateway policy.
Deprecated : this URI will be deprecated after Version: v5_1, not support.
204
Retrieve list ¶
GET/v6_1/rkszones/{zoneId}/bonjourGateway/policies
Use this API command to retrieve a list of bonjour gateway policies.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "510d26e1-05fd-11e6-bfc2-5254002b8a65",
"name": "Bonjour gateway policy name 1",
"description": "Bonjour gateway policy description",
"lastModifiedBy": "user name",
"lastModifiedOn": "2016/07/12 14:38:43"
},
{
"id": "556a6be0-0610-11e6-9de9-bad3cba0b410",
"name": "Bonjour gateway policy name 2",
"description": "Bonjour gateway policy description",
"lastModifiedBy": "user name",
"lastModifiedOn": "2016/07/12 14:38:43"
}
]
}
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 bonjour gateway policy",
"type": "string"
},
"name": {
"description": "Name of the bonjour gateway policy",
"type": "string"
},
"description": {
"description": "Description of the bonjour gateway policy",
"type": "string"
},
"lastModifiedBy": {
"description": "Last modified user of the bonjour gateway policy",
"type": "string"
},
"lastModifiedOn": {
"description": "Last modified time of the bonjour gateway policy",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/bonjourGateway/policies/{id}
Use this API command to retrieve bonjour gateway policy.
200
Body
{
"name": "bonjour gateway policy name",
"description": "bonjour gateway policy description",
"bonjourPolicyRuleList": [
{
"priority": 1,
"bridgeService": "AIRPLAY",
"fromVlan": 15,
"toVlan": 26,
"notes": "notes"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Bonjour Gateway Policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bonjour Gateway Policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"bonjourPolicyRuleList": {
"type": "array",
"description": "Bonjour policy rule list",
"items": {
"type": "object",
"description": "Bonjour policy rule",
"additionalProperties": false,
"properties": {
"priority": {
"description": "Priority",
"type": "string"
},
"bridgeService": {
"description": "Bridge service",
"type": "string"
},
"protocol": {
"description": "protocol",
"type": "string"
},
"fromVlan": {
"description": "From VLAN",
"type": "integer"
},
"toVlan": {
"description": "To VLAN",
"type": "integer"
},
"notes": {
"description": "Notes",
"type": "string",
"maximum": 180
}
}
}
}
}
}
Create ¶
POST/v6_1/rkszones/{zoneId}/bonjourGateway/policies
Use this API command to create bonjour gateway policy.
Body
{
"name": "bonjour gateway policy name",
"description": "bonjour gateway policy description",
"bonjourPolicyRuleList": [
{
"bridgeService": "ITUNES_REMOTE",
"fromVlan": 1,
"toVlan": 10,
"notes": "notes"
}
]
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the Bonjour Gateway Policy",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Bonjour Gateway Policy",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bonjourPolicyRuleList" : {
"type" : "array",
"description" : "Bonjour policy rule list",
"items" : {
"type" : "object",
"description" : "Bonjour policy rule",
"additionalProperties" : false,
"properties" : {
"bridgeService" : {
"description" : "Bridge service",
"enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "OTHER" ]
},
"protocol" : {
"description" : "protocol. This is only available when bridgeService is OTHER",
"type" : "string",
"pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
},
"fromVlan" : {
"description" : "From VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"toVlan" : {
"description" : "To VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"notes" : {
"description" : "Notes",
"type" : "string",
"maximum" : 180
}
},
"required" : [ "bridgeService", "fromVlan", "toVlan" ]
}
}
},
"required" : [ "name" ]
}
201
Body
{
"id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/bonjourGateway/policies/{id}
Use this API command to modify the basic information of bonjour gateway policy.
Body
{
"name": "bonjour gateway policy name",
"description": "bonjour gateway policy description",
"bonjourPolicyRuleList": [
{
"bridgeService": "AIRPLAY",
"fromVlan": 15,
"toVlan": 26,
"notes": "notes"
}
]
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the Bonjour Gateway Policy",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Bonjour Gateway Policy",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bonjourPolicyRuleList" : {
"type" : "array",
"description" : "Bonjour policy rule list",
"items" : {
"type" : "object",
"description" : "Bonjour policy rule",
"additionalProperties" : false,
"properties" : {
"bridgeService" : {
"description" : "Bridge service",
"enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "OTHER" ]
},
"protocol" : {
"description" : "protocol. This is only available when bridgeService is OTHER",
"type" : "string",
"pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
},
"fromVlan" : {
"description" : "From VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"toVlan" : {
"description" : "To VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"notes" : {
"description" : "Notes",
"type" : "string",
"maximum" : 180
}
},
"required" : [ "bridgeService", "fromVlan", "toVlan" ]
}
}
}
}
204
Modify bonjour gateway policy rule list ¶
PATCH/v6_1/rkszones/{zoneId}/bonjourGateway/policies/{id}/bonjourPolicyRuleList
Use this API command to modify bonjour gateway policy rules.
Body
[
{
"bridgeService": "AIRPLAY",
"fromVlan": 15,
"toVlan": 26,
"notes": "notes"
}
]
Schema
{
"type" : "array",
"description" : "Bonjour policy rule list",
"items" : {
"type" : "object",
"description" : "Bonjour policy rule",
"additionalProperties" : false,
"properties" : {
"bridgeService" : {
"description" : "Bridge service",
"enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "OTHER" ]
},
"protocol" : {
"description" : "protocol. This is only available when bridgeService is OTHER",
"type" : "string",
"pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
},
"fromVlan" : {
"description" : "From VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"toVlan" : {
"description" : "To VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"notes" : {
"description" : "Notes",
"type" : "string",
"maximum" : 180
}
},
"required" : [ "bridgeService", "fromVlan", "toVlan" ]
}
}
204
Modify Enable ¶
PATCH/v6_1/rkszones/{zoneId}/bonjourGateway/enable
Use this API command to enable/disable bonjour gateway policy.
Body
{
"enabledBonjourGateway": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enabledBonjourGateway": {
"description": "Enable Bonjour gateway on th AP",
"type": "boolean"
}
},
"required": [
"enabledBonjourGateway"
]
}
204
Bonjour Fencing Policy ¶
Retrieve list ¶
GET/v6_1/rkszones/{zoneId}/bonjourFencingPolicy
Use this API command to retrieve a list of Bonjour Fencing Policy.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "1c942d00-4f36-11e6-8512-0a0027000000",
"name": "bonjourFencingPolicy",
"description": "",
"bonjourFencingRuleList": [
{
"deviceType": "Wired",
"deviceMacList": [
{
"mac": "00:22:33:66:44:55"
},
{
"mac": "00:22:33:66:44:66"
}
],
"closestAp": "33:22:11:22:66:55",
"description": "desc",
"serviceType": "AIRPLAY",
"fencingRange": "SameAp"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "Bonjour Fencing Policy id",
"type": "string"
},
"name": {
"description": "Name of the Bonjour Fencing Policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bonjour Fencing Policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"zoneId": {
"description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
"type": "string"
},
"bonjourFencingRuleList": {
"description": "Bonjour Fencing Rule List",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"deviceType": {
"description": "Name of the Bonjour Fencing Rule",
"enum": [
"Wired",
"Wireless"
]
},
"deviceMacList": {
"description": "profile.bonjourFencingRule.properties.deviceMacList.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "profile.bonjourFencingRuleDeviceMac.properties.mac.description",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"closestAp": {
"description": "Specify the closest AP while device connecting to AP wired",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"serviceType": {
"description": "Bonjour Service Type",
"enum": [
"AIRDISK",
"AIRPLAY",
"AIRPORT_MANAGEMENT",
"AIRPRINT",
"AIRTUNES",
"APPLE_FILE_SHARING",
"APPLE_MOBILE_DEVICES",
"APPLETV",
"ICLOUD_SYNC",
"ITUNES_REMOTE",
"ITUNES_SHARING",
"OPEN_DIRECTORY_MASTER",
"OPTICAL_DISK_SHARING",
"SCREEN_SHARING",
"SECURE_FILE_SHARING",
"SECURE_SHELL",
"WWW_HTTP",
"WWW_HTTPS",
"WORKGROUP_MANAGER",
"XGRID",
"GOOGLE_CHROMECAST"
]
},
"fencingRange": {
"description": "The range of AP can take Bonjour work",
"enum": [
"SameAp",
"OneHopAp"
]
},
"description": {
"description": "Description of the Bonjour Fencing Rule",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"deviceType",
"serviceType",
"fencingRange"
]
}
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
}
},
"required": [
"name",
"bonjourFencingRuleList"
]
}
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/bonjourFencingPolicy/{id}
Use this API command to retrieve Bonjour Fencing Policy.
200
Body
{
"id": "1c942d00-4f36-11e6-8512-0a0027000000",
"name": "bonjourPolicy",
"description": "",
"bonjourFencingRuleList": [
{
"deviceType": "Wired",
"deviceMacList": [
{
"mac": "00:22:33:66:44:55"
},
{
"mac": "00:22:33:66:44:66"
}
],
"closestAp": "33:22:11:22:66:55",
"description": "desc",
"serviceType": "AIRPLAY",
"fencingRange": "SameAp"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Bonjour Fencing Policy id",
"type": "string"
},
"name": {
"description": "Name of the Bonjour Fencing Policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bonjour Fencing Policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"zoneId": {
"description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
"type": "string"
},
"bonjourFencingRuleList": {
"description": "Bonjour Fencing Rule List",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"deviceType": {
"description": "Name of the Bonjour Fencing Rule",
"enum": [
"Wired",
"Wireless"
]
},
"deviceMacList": {
"description": "profile.bonjourFencingRule.properties.deviceMacList.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "profile.bonjourFencingRuleDeviceMac.properties.mac.description",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"closestAp": {
"description": "Specify the closest AP while device connecting to AP wired",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"serviceType": {
"description": "Bonjour Service Type",
"enum": [
"AIRDISK",
"AIRPLAY",
"AIRPORT_MANAGEMENT",
"AIRPRINT",
"AIRTUNES",
"APPLE_FILE_SHARING",
"APPLE_MOBILE_DEVICES",
"APPLETV",
"ICLOUD_SYNC",
"ITUNES_REMOTE",
"ITUNES_SHARING",
"OPEN_DIRECTORY_MASTER",
"OPTICAL_DISK_SHARING",
"SCREEN_SHARING",
"SECURE_FILE_SHARING",
"SECURE_SHELL",
"WWW_HTTP",
"WWW_HTTPS",
"WORKGROUP_MANAGER",
"XGRID",
"GOOGLE_CHROMECAST"
]
},
"fencingRange": {
"description": "The range of AP can take Bonjour work",
"enum": [
"SameAp",
"OneHopAp"
]
},
"description": {
"description": "Description of the Bonjour Fencing Rule",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"deviceType",
"serviceType",
"fencingRange"
]
}
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
}
},
"required": [
"name",
"bonjourFencingRuleList"
]
}
Create ¶
POST/v6_1/rkszones/{zoneId}/bonjourFencingPolicy
Use this API command to create Bonjour Fencing Policy.
Body
{
"name": "bonjourPolicy",
"description": "",
"bonjourFencingRuleList": [
{
"deviceType": "Wired",
"deviceMacList": [
{
"mac": "00:22:33:66:44:55"
},
{
"mac": "00:22:33:66:44:66"
}
],
"closestAp": "33:22:11:22:66:55",
"description": "desc",
"serviceType": "AIRPLAY",
"fencingRange": "SameAp"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Bonjour Fencing Policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bonjour Fencing Policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"bonjourFencingRuleList": {
"description": "Bonjour Fencing Rule List",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"deviceType": {
"description": "Name of the Bonjour Fencing Rule",
"enum": [
"Wired",
"Wireless"
]
},
"deviceMacList": {
"description": "profile.bonjourFencingRule.properties.deviceMacList.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "profile.bonjourFencingRuleDeviceMac.properties.mac.description",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"closestAp": {
"description": "Specify the closest AP while device connecting to AP wired",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"serviceType": {
"description": "Bonjour Service Type",
"enum": [
"AIRDISK",
"AIRPLAY",
"AIRPORT_MANAGEMENT",
"AIRPRINT",
"AIRTUNES",
"APPLE_FILE_SHARING",
"APPLE_MOBILE_DEVICES",
"APPLETV",
"ICLOUD_SYNC",
"ITUNES_REMOTE",
"ITUNES_SHARING",
"OPEN_DIRECTORY_MASTER",
"OPTICAL_DISK_SHARING",
"SCREEN_SHARING",
"SECURE_FILE_SHARING",
"SECURE_SHELL",
"WWW_HTTP",
"WWW_HTTPS",
"WORKGROUP_MANAGER",
"XGRID",
"GOOGLE_CHROMECAST"
]
},
"fencingRange": {
"description": "The range of AP can take Bonjour work",
"enum": [
"SameAp",
"OneHopAp"
]
},
"description": {
"description": "Description of the Bonjour Fencing Rule",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"deviceType",
"serviceType",
"fencingRange"
]
}
}
},
"required": [
"name",
"bonjourFencingRuleList"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/bonjourFencingPolicy/{id}
Use this API command to modify the basic information of Bonjour Fencing Policy.
Body
{
"name": "bonjourPolicy123",
"description": "this is desc",
"bonjourFencingRuleList": [
{
"deviceType": "Wireless",
"description": "desc",
"serviceType": "AIRPLAY",
"fencingRange": "SameAp"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Bonjour Fencing Rule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bonjour Fencing Rule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"bonjourFencingRuleList": {
"description": "Bonjour Fencing Rule List",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"deviceType": {
"description": "Name of the Bonjour Fencing Rule",
"enum": [
"Wired",
"Wireless"
]
},
"deviceMacList": {
"description": "profile.bonjourFencingRule.properties.deviceMacList.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "profile.bonjourFencingRuleDeviceMac.properties.mac.description",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"closestAp": {
"description": "Specify the closest AP while device connecting to AP wired",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"serviceType": {
"description": "Bonjour Service Type",
"enum": [
"AIRDISK",
"AIRPLAY",
"AIRPORT_MANAGEMENT",
"AIRPRINT",
"AIRTUNES",
"APPLE_FILE_SHARING",
"APPLE_MOBILE_DEVICES",
"APPLETV",
"ICLOUD_SYNC",
"ITUNES_REMOTE",
"ITUNES_SHARING",
"OPEN_DIRECTORY_MASTER",
"OPTICAL_DISK_SHARING",
"SCREEN_SHARING",
"SECURE_FILE_SHARING",
"SECURE_SHELL",
"WWW_HTTP",
"WWW_HTTPS",
"WORKGROUP_MANAGER",
"XGRID",
"GOOGLE_CHROMECAST"
]
},
"fencingRange": {
"description": "The range of AP can take Bonjour work",
"enum": [
"SameAp",
"OneHopAp"
]
},
"description": {
"description": "Description of the Bonjour Fencing Rule",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"deviceType",
"serviceType",
"fencingRange"
]
}
}
}
}
204
Modify Bonjour Fencing Rule List ¶
PATCH/v6_1/rkszones/{zoneId}/bonjourFencingPolicy/{id}/bonjourFencingRuleList
Use this API command to modify Bonjour Fencing Rule List.
Body
[
{
"deviceType": "Wireless",
"description": "desc",
"serviceType": "AIRPLAY",
"fencingRange": "SameAp"
}
]
Schema
{
"description": "Bonjour Fencing Rule List",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"deviceType": {
"description": "Name of the Bonjour Fencing Rule",
"enum": [
"Wired",
"Wireless"
]
},
"deviceMacList": {
"description": "profile.bonjourFencingRule.properties.deviceMacList.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "profile.bonjourFencingRuleDeviceMac.properties.mac.description",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"closestAp": {
"description": "Specify the closest AP while device connecting to AP wired",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"serviceType": {
"description": "Bonjour Service Type",
"enum": [
"AIRDISK",
"AIRPLAY",
"AIRPORT_MANAGEMENT",
"AIRPRINT",
"AIRTUNES",
"APPLE_FILE_SHARING",
"APPLE_MOBILE_DEVICES",
"APPLETV",
"ICLOUD_SYNC",
"ITUNES_REMOTE",
"ITUNES_SHARING",
"OPEN_DIRECTORY_MASTER",
"OPTICAL_DISK_SHARING",
"SCREEN_SHARING",
"SECURE_FILE_SHARING",
"SECURE_SHELL",
"WWW_HTTP",
"WWW_HTTPS",
"WORKGROUP_MANAGER",
"XGRID",
"GOOGLE_CHROMECAST"
]
},
"fencingRange": {
"description": "The range of AP can take Bonjour work",
"enum": [
"SameAp",
"OneHopAp"
]
},
"description": {
"description": "Description of the Bonjour Fencing Rule",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"deviceType",
"serviceType",
"fencingRange"
]
}
}
204
Delete ¶
DELETE/v6_1/rkszones/bonjourFencingPolicy/{id}
Use this API command to delete Bonjour Fencing Policy.
204
Delete ¶
DELETE/v6_1/rkszones/bonjourFencingPolicy
Use this API command to delete Bulk Bonjour Fencing Policy.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Get Bonjour Fencing Statistic ¶
GET/v6_1/aps/{apMac}/bonjourFencingStatistic
Use this API command to get Bonjour Fencing Statistic per AP.
200
Body
{
"apMac": "33:22:11:22:66:44",
"forwardedPackets": 30,
"droppedPacketsDueToServiceType": 40,
"droppedPacketsDueToNeighbor": 50,
"serviceList": [
{
"serviceType": "AIRPLAY",
"sourceType": "DIRECT"
},
{
"serviceType": "AIRTUNES",
"sourceType": "NEIGHBOR",
"neighborApMac": "33:22:11:22:66:55"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"forwardedPackets": {
"type": "integer"
},
"droppedPacketsDueToServiceType": {
"type": "integer"
},
"droppedPacketsDueToNeighbor": {
"type": "integer"
},
"serviceList": {
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"sourceType": {
"enum": [
"UNKNOWN",
"DIRECT",
"NEIGHBOR"
]
},
"neighborApMac": {
"type": "string"
},
"serviceType": {
"enum": [
"AIRDISK",
"AIRPLAY",
"AIRPORT_MANAGEMENT",
"AIRPRINT",
"AIRTUNES",
"APPLE_FILE_SHARING",
"APPLE_MOBILE_DEVICES",
"APPLETV",
"ICLOUD_SYNC",
"ITUNES_REMOTE",
"ITUNES_SHARING",
"OPEN_DIRECTORY_MASTER",
"OPTICAL_DISK_SHARING",
"SCREEN_SHARING",
"SECURE_FILE_SHARING",
"SECURE_SHELL",
"WWW_HTTP",
"WWW_HTTPS",
"WORKGROUP_MANAGER",
"XGRID"
]
}
}
}
}
}
}
Retrieve list ¶
POST/v6_1/query/services/bonjourFencingPolicy
Use this API command to retrieve a list of Bonjour Fencing Policy. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "1c942d00-4f36-11e6-8512-0a0027000000",
"name": "bonjourFencingPolicy",
"description": "",
"bonjourFencingRuleList": [
{
"deviceType": "Wired",
"deviceMacList": [
{
"mac": "00:22:33:66:44:55"
},
{
"mac": "00:22:33:66:44:66"
}
],
"closestAp": "33:22:11:22:66:55",
"description": "desc",
"serviceType": "AIRPLAY",
"fencingRange": "SameAp"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "Bonjour Fencing Policy id",
"type": "string"
},
"name": {
"description": "Name of the Bonjour Fencing Policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bonjour Fencing Policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"zoneId": {
"description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
"type": "string"
},
"bonjourFencingRuleList": {
"description": "Bonjour Fencing Rule List",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"deviceType": {
"description": "Name of the Bonjour Fencing Rule",
"enum": [
"Wired",
"Wireless"
]
},
"deviceMacList": {
"description": "profile.bonjourFencingRule.properties.deviceMacList.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "profile.bonjourFencingRuleDeviceMac.properties.mac.description",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"closestAp": {
"description": "Specify the closest AP while device connecting to AP wired",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"serviceType": {
"description": "Bonjour Service Type",
"enum": [
"AIRDISK",
"AIRPLAY",
"AIRPORT_MANAGEMENT",
"AIRPRINT",
"AIRTUNES",
"APPLE_FILE_SHARING",
"APPLE_MOBILE_DEVICES",
"APPLETV",
"ICLOUD_SYNC",
"ITUNES_REMOTE",
"ITUNES_SHARING",
"OPEN_DIRECTORY_MASTER",
"OPTICAL_DISK_SHARING",
"SCREEN_SHARING",
"SECURE_FILE_SHARING",
"SECURE_SHELL",
"WWW_HTTP",
"WWW_HTTPS",
"WORKGROUP_MANAGER",
"XGRID",
"GOOGLE_CHROMECAST"
]
},
"fencingRange": {
"description": "The range of AP can take Bonjour work",
"enum": [
"SameAp",
"OneHopAp"
]
},
"description": {
"description": "Description of the Bonjour Fencing Rule",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"deviceType",
"serviceType",
"fencingRange"
]
}
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
}
},
"required": [
"name",
"bonjourFencingRuleList"
]
}
}
}
}
Client Isolation Whitelist ¶
Create Client Isolation Whitelist ¶
POST/v6_1/rkszones/{zoneId}/clientIsolationWhitelist
Create a new ClientIsolationWhitelist.
Body
{
"name": "clientIsolationWhitelist_1",
"description": "",
"whitelist": [
{
"mac": "00:22:33:66:44:55",
"ip": "10.2.3.111",
"description": "desc"
},
{
"mac": "00:22:33:66:44:66",
"ip": "10.2.3.123",
"description": "desc2"
}
],
"clientIsolationAutoEnabled": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Client Isolation Whitelist name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Client Isolation Whitelist description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"whitelist": {
"description": "Client Isolation Whitelist array",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Entry Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"ip": {
"description": "Client Entry ip",
"type": [
"string",
"null"
]
},
"description": {
"description": "Client Entry description",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"mac"
]
}
},
"clientIsolationAutoEnabled": {
"description": "Client Isolation Auto Enable",
"type": "boolean"
}
},
"required": [
"name",
"whitelist",
"clientIsolationAutoEnabled"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Retrieve List ¶
GET/v6_1/rkszones/{zoneId}/clientIsolationWhitelist
Retrieve a list of Client Isolation Whitelist.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "1c942d00-4f36-11e6-8512-0a0027000000",
"name": "clientIsolationWhitelist_1",
"description": "",
"whitelist": [
{
"mac": "00:22:33:66:44:55",
"ip": "10.2.3.111",
"description": "desc"
},
{
"mac": "00:22:33:66:44:66",
"ip": "10.2.3.123",
"description": "desc2"
}
],
"clientIsolationAutoEnabled": true
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "Client Isolation Whitelist id",
"type": "string"
},
"name": {
"description": "Client Isolation Whitelist name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Client Isolation Whitelist description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"zoneId": {
"description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
"type": "string"
},
"whitelist": {
"description": "Client Isolation Whitelist array",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Entry Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"ip": {
"description": "Client Entry ip",
"type": [
"string",
"null"
]
},
"description": {
"description": "Client Entry description",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"mac"
]
}
},
"clientIsolationAutoEnabled": {
"description": "Client Isolation Auto Enable",
"type": "boolean"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
}
},
"required": [
"name",
"whitelist",
"clientIsolationAutoEnabled"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/rkszones/{zoneId}/clientIsolationWhitelist/{id}
Retrieve an Client Isolation Whitelist.
200
Body
{
"id": "1c942d00-4f36-11e6-8512-0a0027000000",
"name": "clientIsolationWhitelist_1",
"description": "",
"whitelist": [
{
"mac": "00:22:33:66:44:55",
"ip": "10.2.3.111",
"description": "desc"
},
{
"mac": "00:22:33:66:44:66",
"ip": "10.2.3.123",
"description": "desc2"
}
],
"clientIsolationAutoEnabled": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Client Isolation Whitelist id",
"type": "string"
},
"name": {
"description": "Client Isolation Whitelist name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Client Isolation Whitelist description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"zoneId": {
"description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
"type": "string"
},
"whitelist": {
"description": "Client Isolation Whitelist array",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Entry Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"ip": {
"description": "Client Entry ip",
"type": [
"string",
"null"
]
},
"description": {
"description": "Client Entry description",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"mac"
]
}
},
"clientIsolationAutoEnabled": {
"description": "Client Isolation Auto Enable",
"type": "boolean"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
}
},
"required": [
"name",
"whitelist",
"clientIsolationAutoEnabled"
]
}
Modify ¶
PATCH/v6_1/rkszones/{zoneId}/clientIsolationWhitelist/{id}
Modify a specific Client Isolation Whitelist basic.
Body
{
"name": "clientIsolationWhitelist_1",
"description": "this is desc",
"whitelist": [
{
"mac": "AA:22:33:66:44:55",
"ip": "10.2.3.111",
"description": "desc"
},
{
"mac": "AA:22:33:66:44:66",
"ip": "10.2.3.99",
"description": "desc2"
}
],
"clientIsolationAutoEnabled": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Client Isolation Whitelist name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Client Isolation Whitelist description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"whitelist": {
"description": "Client Isolation Whitelist array",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Entry Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"ip": {
"description": "Client Entry ip",
"type": [
"string",
"null"
]
},
"description": {
"description": "Client Entry description",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"mac"
]
}
},
"clientIsolationAutoEnabled": {
"description": "Client Isolation Auto Enable",
"type": "boolean"
}
}
}
204
Modify Client Isolation Whitelist entries configuration ¶
PATCH/v6_1/rkszones/{zoneId}/clientIsolationWhitelist/{id}/whitelist
Modify Client Isolation Whitelist entries configuration.
Body
[
{
"mac": "AA:22:33:66:44:55",
"ip": "10.2.3.111",
"description": "desc"
},
{
"mac": "AA:22:33:66:44:66",
"ip": "10.2.3.99",
"description": "desc2"
}
]
Schema
{
"description": "Client Isolation Whitelist array",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Entry Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"ip": {
"description": "Client Entry ip",
"type": [
"string",
"null"
]
},
"description": {
"description": "Client Entry description",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"mac"
]
}
}
204
Delete ¶
Delete ¶
DELETE/v6_1/rkszones/clientIsolationWhitelist
Use this API command to delete Bulk Client Isolation Whitelist.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Retrieve List ¶
POST/v6_1/query/services/clientIsolationWhitelist
Retrieve a list of Client Isolation Whitelist. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "1c942d00-4f36-11e6-8512-0a0027000000",
"name": "clientIsolationWhitelist_1",
"description": "",
"whitelist": [
{
"mac": "00:22:33:66:44:55",
"ip": "10.2.3.111",
"description": "desc"
},
{
"mac": "00:22:33:66:44:66",
"ip": "10.2.3.123",
"description": "desc2"
}
],
"clientIsolationAutoEnabled": true
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "Client Isolation Whitelist id",
"type": "string"
},
"name": {
"description": "Client Isolation Whitelist name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Client Isolation Whitelist description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"zoneId": {
"description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
"type": "string"
},
"whitelist": {
"description": "Client Isolation Whitelist array",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Entry Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"ip": {
"description": "Client Entry ip",
"type": [
"string",
"null"
]
},
"description": {
"description": "Client Entry description",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"mac"
]
}
},
"clientIsolationAutoEnabled": {
"description": "Client Isolation Auto Enable",
"type": "boolean"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
}
},
"required": [
"name",
"whitelist",
"clientIsolationAutoEnabled"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Rogue Classification Policy ¶
Retrieve rogue AP policy. ¶
GET/v6_1/rkszones/{zoneId}/rogueApPolicies/{id}
Use this API command to retrieve rogue AP policy.
200
Body
{
"id": "ddedfc70-6b95-11e7-98f9-0a0027000000",
"name": "Rogue AP Policy",
"description": "Description",
"defaultPolicy": false,
"active": false,
"rules": [
{
"type": "MacSpoofingRule",
"name": "MAC Spoofing Rule",
"priority": 2,
"value": "mac-spoof",
"classification": "Malicious",
"plainTypeString": "Malicious AP (MAC-spoof)"
},
{
"type": "SameNetworkRule",
"name": "Same Network Rule",
"priority": 1,
"value": "same-network",
"classification": "Malicious",
"plainTypeString": "Malicious AP (Same-Network)"
}
],
"applyToResourceId": "",
"applyToResourceType": "None",
"zoneId": "b7b87594-ef45-4591-85e0-f344f8a3fe7c",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"modifiedDateTime": 1484720657237,
"modifierUsername": "Admin"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "profile.rogueApPolicy.properties.id.description",
"type": "string"
},
"name": {
"description": "profile.rogueApPolicy.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "profile.rogueApPolicy.properties.description.description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"rules": {
"description": "profile.rogueApPolicy.properties.rules.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "profile.rogueApRuleList.properties.name.description",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"type": {
"description": "profile.rogueApRuleList.properties.type.description",
"enum": [
"SsidSpoofingRule",
"MacSpoofingRule",
"SameNetworkRule",
"CustomSsidRule",
"CustomRssiRule",
"CustomMacOuiRule"
]
},
"value": {
"description": "profile.rogueApRuleList.properties.value.description"
},
"priority": {
"type": "integer",
"description": "profile.rogueApRuleList.properties.priority.description"
},
"classification": {
"description": "profile.rogueApRuleList.properties.classification.description",
"enum": [
"Ignore",
"Known",
"Rogue",
"Malicious"
]
}
}
}
},
"zoneId": {
"type": "string",
"description": "profile.rogueApPolicy.properties.zoneId.description"
},
"modifiedDateTime": {
"description": "profile.rogueApPolicy.properties.modifiedDateTime.description",
"type": "integer"
},
"modifierUsername": {
"description": "profile.rogueApPolicy.properties.modifierUsername.description",
"type": "string"
},
"createDateTime": {
"description": "profile.rogueApPolicy.properties.createDateTime.description",
"type": "integer"
},
"creatorId": {
"description": "profile.rogueApPolicy.properties.creatorId.description",
"type": "string"
},
"modifierId": {
"description": "profile.rogueApPolicy.properties.modifierId.description",
"type": "string"
},
"creatorUsername": {
"description": "profile.rogueApPolicy.properties.creatorUsername.description",
"type": "string"
}
}
}
Modify rogue AP policy. ¶
PATCH/v6_1/rkszones/{zoneId}/rogueApPolicies/{id}
Use this API command to modify rogue AP policy.
Body
{
"name": "Update Rogue AP Policy",
"description": "This is description",
"rules": [
{
"type": "CustomMacOuiRule",
"name": "New rule",
"priority": 1,
"value": "22:33:44",
"classification": "Malicious"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "profile.updateRogueApPolicy.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "profile.updateRogueApPolicy.properties.description.description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"rules": {
"description": "profile.updateRogueApPolicy.properties.rules.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "profile.rogueApRuleList.properties.name.description",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"type": {
"description": "profile.rogueApRuleList.properties.type.description",
"enum": [
"SsidSpoofingRule",
"MacSpoofingRule",
"SameNetworkRule",
"CustomSsidRule",
"CustomRssiRule",
"CustomMacOuiRule"
]
},
"value": {
"description": "profile.rogueApRuleList.properties.value.description"
},
"priority": {
"type": "integer",
"description": "profile.rogueApRuleList.properties.priority.description"
},
"classification": {
"description": "profile.rogueApRuleList.properties.classification.description",
"enum": [
"Ignore",
"Known",
"Rogue",
"Malicious"
]
}
}
}
}
}
}
204
Create rogue AP policy. ¶
POST/v6_1/rkszones/{zoneId}/rogueApPolicies
Use this API command to create rogue AP policy.
Body
{
"name": "Rogue AP Policy",
"description": "Description",
"rules": [
{
"name": "Rule name",
"type": "CustomMacOuiRule",
"value": "11:22:33",
"classification": "Malicious",
"priority": 1
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "profile.createRogueApPolicy.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "profile.createRogueApPolicy.properties.description.description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"rules": {
"description": "profile.createRogueApPolicy.properties.rules.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "profile.rogueApRuleList.properties.name.description",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"type": {
"description": "profile.rogueApRuleList.properties.type.description",
"enum": [
"SsidSpoofingRule",
"MacSpoofingRule",
"SameNetworkRule",
"CustomSsidRule",
"CustomRssiRule",
"CustomMacOuiRule"
]
},
"value": {
"description": "profile.rogueApRuleList.properties.value.description"
},
"priority": {
"type": "integer",
"description": "profile.rogueApRuleList.properties.priority.description"
},
"classification": {
"description": "profile.rogueApRuleList.properties.classification.description",
"enum": [
"Ignore",
"Known",
"Rogue",
"Malicious"
]
}
}
}
}
},
"required": [
"name",
"rules"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Delete rogue AP policy. ¶
DELETE/v6_1/rkszones/{zoneId}/rogueApPolicies/{id}
Use this API command to delete rogue AP policy.
200
Delete bulk rogue AP policy. ¶
DELETE/v6_1/rkszones/{zoneId}/rogueApPolicies
Use this API command to delete bulk rogue AP policy.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Retrieve a list of rogue AP policy. ¶
GET/v6_1/rkszones/{zoneId}/rogueApPolicies
Use this API command to retrieve a list of rogue AP policy.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"name": "Default Policy",
"description": "This is description",
"modifierUsername": "User name",
"modifiedDateTime": "1499329195189",
"list": [
{
"id": "94b903e1-6223-11e7-9bbb-0a0027000000",
"rules": [
{
"type": "SsidSpoofingRule",
"name": "SSID Spoofing Rule",
"priority": 3,
"value": "ssid-spoof",
"classification": "Malicious"
},
{
"type": "MacSpoofingRule",
"name": "MAC Spoofing Rule",
"priority": 2,
"value": "mac-spoof",
"classification": "Malicious"
},
{
"type": "CustomMacOuiRule",
"name": "Rule name",
"priority": 1,
"value": "22:33:44",
"classification": "Malicious"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "profile.rogueApPolicy.properties.id.description",
"type": "string"
},
"name": {
"description": "profile.rogueApPolicy.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "profile.rogueApPolicy.properties.description.description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"rules": {
"description": "profile.rogueApPolicy.properties.rules.description",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "profile.rogueApRuleList.properties.name.description",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"type": {
"description": "profile.rogueApRuleList.properties.type.description",
"enum": [
"SsidSpoofingRule",
"MacSpoofingRule",
"SameNetworkRule",
"CustomSsidRule",
"CustomRssiRule",
"CustomMacOuiRule"
]
},
"value": {
"description": "profile.rogueApRuleList.properties.value.description"
},
"priority": {
"type": "integer",
"description": "profile.rogueApRuleList.properties.priority.description"
},
"classification": {
"description": "profile.rogueApRuleList.properties.classification.description",
"enum": [
"Ignore",
"Known",
"Rogue",
"Malicious"
]
}
}
}
},
"zoneId": {
"type": "string",
"description": "profile.rogueApPolicy.properties.zoneId.description"
},
"modifiedDateTime": {
"description": "profile.rogueApPolicy.properties.modifiedDateTime.description",
"type": "integer"
},
"modifierUsername": {
"description": "profile.rogueApPolicy.properties.modifierUsername.description",
"type": "string"
},
"createDateTime": {
"description": "profile.rogueApPolicy.properties.createDateTime.description",
"type": "integer"
},
"creatorId": {
"description": "profile.rogueApPolicy.properties.creatorId.description",
"type": "string"
},
"modifierId": {
"description": "profile.rogueApPolicy.properties.modifierId.description",
"type": "string"
},
"creatorUsername": {
"description": "profile.rogueApPolicy.properties.creatorUsername.description",
"type": "string"
}
}
}
}
}
}
Authentication Service ¶
Retrieve List - All types of Authentication Service by query criteria ¶
POST/v6_1/services/auth/query
Use this API command to retrieve a list of Authentication services by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "accountingServiceUUID",
"mvnoId": "userMVNOId",
"domainId": "userDomainId",
"name": "accountingServiceName",
"description": "accountingServiceDescription",
"protocol": "RADIUS"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for authentication servers",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"RADIUS",
"AD",
"LDAP",
"FACEBOOK",
"LINKEDIN",
"GOOGLE",
"GENERICOAUTH",
"SOAP",
"HLR",
"LOCAL_DB",
"GUEST"
]
},
"type": {
"description": "Authentication protocol same as protocol.",
"enum": [
"RADIUS",
"AD",
"LDAP",
"FACEBOOK",
"LINKEDIN",
"GOOGLE",
"GENERICOAUTH",
"SOAP",
"HLR",
"LOCAL_DB",
"GUEST"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Delete authentication Service ¶
DELETE/v6_1/services/auth/{id}
Use this API command to delete an authentication service.
204
Delete a list of authentication Service ¶
DELETE/v6_1/services/auth
Use this API command to delete a list of authentication service.
Body
{
"idList": [
"839f87c6-d116-497e-afce-aa8157abdasd"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Test specific authentication Service ¶
POST/v6_1/services/auth/test/{id}
Use this API command to test an authentication service.
Body
{
"id": "839f87c6-d116-497e-afce-aa8157abdasd",
"loginRequest": {
"password": "adsf",
"userName": "test",
"timeZoneUtcOffset": "+8",
"protocol": ""
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"loginRequest": {
"type": "object",
"properties": {
"password": {
"description": "password for test user",
"type": "string"
},
"userName": {
"description": "name for test user",
"type": "string"
},
"timeZoneUtcOffset": {
"description": "timezone offset, ex: '+8'",
"type": "string"
},
"protocol": {
"description": "",
"type": "string"
}
}
}
}
}
204
Retrieve - LocalDB Authentication Service ¶
GET/v6_1/services/auth/local_db/{id}
Use this API command to retrieve a LocalDB authentication service.
200
Body
{
"id": "accountingServiceUUID",
"mvnoId": "userMVNOId",
"domainId": "userDomainId",
"name": "accountingServiceName",
"description": "accountingServiceDescription",
"protocol": "RADIUS"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"RADIUS",
"AD",
"LDAP",
"FACEBOOK",
"LINKEDIN",
"GOOGLE",
"GENERICOAUTH",
"SOAP",
"HLR",
"LOCAL_DB",
"GUEST"
]
},
"type": {
"description": "Authentication protocol same as protocol.",
"enum": [
"RADIUS",
"AD",
"LDAP",
"FACEBOOK",
"LINKEDIN",
"GOOGLE",
"GENERICOAUTH",
"SOAP",
"HLR",
"LOCAL_DB",
"GUEST"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Update LocalDB Authentication Service ¶
PATCH/v6_1/services/auth/local_db/{id}
Use this API command to update LocalDB authentication service.
Body
{
"domainId": "8b3881d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "local db",
"friendlyName": "aaa",
"description": "ddd",
"type": "LOCAL_DB",
"mvnoId": "897f87c6-d116-497e-afce-aa8157abd30c"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the RADIUS authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"LOCAL_DB"
]
},
"type": {
"description": "Authentication protocol.",
"enum": [
"LOCAL_DB"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Update user role mappings of LocalDB Authentication Service ¶
PATCH/v6_1/services/auth/local_db/{id}/mappings
Use this API command to update user role mappings of LocalDB authentication service.
Schema
{
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
204
Retrieve - Guest Authentication Service ¶
GET/v6_1/services/auth/guest/{id}
Use this API command to retrieve a Guest authentication service.
200
Body
{
"id": "accountingServiceUUID",
"mvnoId": "userMVNOId",
"domainId": "userDomainId",
"name": "accountingServiceName",
"description": "accountingServiceDescription",
"protocol": "RADIUS"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"RADIUS",
"AD",
"LDAP",
"FACEBOOK",
"LINKEDIN",
"GOOGLE",
"GENERICOAUTH",
"SOAP",
"HLR",
"LOCAL_DB",
"GUEST"
]
},
"type": {
"description": "Authentication protocol same as protocol.",
"enum": [
"RADIUS",
"AD",
"LDAP",
"FACEBOOK",
"LINKEDIN",
"GOOGLE",
"GENERICOAUTH",
"SOAP",
"HLR",
"LOCAL_DB",
"GUEST"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve List - Radius Authentication Service by query criteria ¶
POST/v6_1/services/auth/radius/query
Use this API command to retrieve a list of radius Authentication services by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "82109ce0-64e6-11e4-8916-0026b9f85aaf",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "userDomainId",
"protocol": "RADIUS",
"name": "rapheal-auth-x3",
"friendlyName": "rapheal-auth-x",
"description": "authentication service created by rapheal via public API",
"mappings": [
{
"id": "73587760-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "abc",
"userRole": {
"id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
"name": "identity user role name",
"userTrafficProfile": {
"id": "9474cc20-63cf-11e4-a18a-080027b147d4",
"name": "rapheal-usertraffic-profile"
}
}
},
{
"id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "*",
"userRole": {
"id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
"name": "identity user role name",
"userTrafficProfile": {
"id": "03ec5340-60a4-11e4-87fc-080027b147d4",
"name": "System Default"
}
}
}
],
"primary": {
"ip": "1.1.1.155",
"port": 1812,
"sharedSecret": "abc"
},
"secondary": {
"ip": "2.2.2.231",
"port": 1812,
"sharedSecret": "abc"
},
"healthCheckPolicy": {
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
},
"rateLimiting": {
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for radius authentication",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the RADIUS authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"RADIUS"
]
},
"type": {
"description": "Authentication protocol.",
"enum": [
"RADIUS"
]
},
"description": {
"description": "Description of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"locationDeliveryEnabled": {
"description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type": "boolean",
"default": false
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve List - RADIUS Authentication Service ¶
GET/v6_1/services/auth/radius
Use this API command to retrieve a list of RADIUS authentication services.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "82109ce0-64e6-11e4-8916-0026b9f85aaf",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "userDomainId",
"protocol": "RADIUS",
"name": "rapheal-auth-x3",
"friendlyName": "rapheal-auth-x",
"description": "authentication service created by rapheal via public API",
"mappings": [
{
"id": "73587760-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "abc",
"userRole": {
"id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
"name": "identity user role name",
"userTrafficProfile": {
"id": "9474cc20-63cf-11e4-a18a-080027b147d4",
"name": "rapheal-usertraffic-profile"
}
}
},
{
"id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "*",
"userRole": {
"id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
"name": "identity user role name",
"userTrafficProfile": {
"id": "03ec5340-60a4-11e4-87fc-080027b147d4",
"name": "System Default"
}
}
}
],
"primary": {
"ip": "1.1.1.155",
"port": 1812,
"sharedSecret": "abc"
},
"secondary": {
"ip": "2.2.2.231",
"port": 1812,
"sharedSecret": "abc"
},
"healthCheckPolicy": {
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
},
"rateLimiting": {
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for radius authentication",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the RADIUS authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"RADIUS"
]
},
"type": {
"description": "Authentication protocol.",
"enum": [
"RADIUS"
]
},
"description": {
"description": "Description of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"locationDeliveryEnabled": {
"description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type": "boolean",
"default": false
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve - RADIUS Authentication Service ¶
GET/v6_1/services/auth/radius/{id}
Use this API command to retrieve a RADIUS authentication service.
200
Body
{
"id": "82109ce0-64e6-11e4-8916-0026b9f85aaf",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "userDomainId",
"protocol": "RADIUS",
"name": "rapheal-auth-x3",
"friendlyName": "rapheal-auth-x",
"description": "authentication service created by rapheal via public API",
"mappings": [
{
"id": "73587760-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "abc",
"userRole": {
"id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
"name": "identity user role name",
"userTrafficProfile": {
"id": "9474cc20-63cf-11e4-a18a-080027b147d4",
"name": "rapheal-usertraffic-profile"
}
}
},
{
"id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "*",
"userRole": {
"id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
"name": "identity user role name",
"userTrafficProfile": {
"id": "03ec5340-60a4-11e4-87fc-080027b147d4",
"name": "System Default"
}
}
}
],
"primary": {
"ip": "1.1.1.155",
"port": 1812,
"sharedSecret": "abc"
},
"secondary": {
"ip": "2.2.2.231",
"port": 1812,
"sharedSecret": "abc"
},
"healthCheckPolicy": {
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
},
"rateLimiting": {
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the RADIUS authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"RADIUS"
]
},
"type": {
"description": "Authentication protocol.",
"enum": [
"RADIUS"
]
},
"description": {
"description": "Description of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"locationDeliveryEnabled": {
"description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type": "boolean",
"default": false
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create - RADIUS Authentication Service ¶
POST/v6_1/services/auth/radius
Use this API command to create a new RADIUS authentication service.
Body
{
"name": "authenticationServiceName",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "abc"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the RADIUS authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"locationDeliveryEnabled": {
"description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type": "boolean",
"default": false
},
"type": {
"description": "",
"enum": [
"RADIUS"
]
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
},
"required": [
"name",
"primary"
]
}
201
Body
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify - RADIUS Authentication Service ¶
PATCH/v6_1/services/auth/radius/{id}
Use this API command to modify the basic information of a RADIUS authentication service.
Body
{
"name": "new name",
"description": "new description",
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
],
"primary": {
"ip": "1.1.1.155",
"port": 1812,
"sharedSecret": "abc"
},
"secondary": {
"ip": "2.2.2.231",
"port": 1812,
"sharedSecret": "abc"
},
"healthCheckPolicy": {
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
},
"rateLimiting": {
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the RADIUS authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the RADIUS authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"locationDeliveryEnabled": {
"description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type": "boolean",
"default": false
},
"type": {
"description": "",
"enum": [
"RADIUS"
]
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Modify - Primary RADIUS Server of Authentication Service ¶
PATCH/v6_1/services/auth/radius/{id}/primary
Use this API command to modify primary RADIUS server of a RADIUS authentication service.
Body
{
"ip": "1.1.1.155",
"port": 1812,
"sharedSecret": "abc"
}
Schema
{
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
204
Modify - Secondary RADIUS Server of Authentication Service ¶
PATCH/v6_1/services/auth/radius/{id}/secondary
Use this API command to modify secondary RADIUS server of a RADIUS authentication service.
Body
{
"ip": "2.2.2.231",
"port": 1812,
"sharedSecret": "abc"
}
Schema
{
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
}
204
Modify - Rate Limiting of Authentication Service ¶
PATCH/v6_1/services/auth/radius/{id}/rateLimiting
Use this API command to modify rate limiting of a RADIUS authentication service.
Body
{
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
Schema
{
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
}
204
Modify - Health Check Policy of Authentication Service ¶
PATCH/v6_1/services/auth/radius/{id}/healthCheckPolicy
Use this API command to modify health check policy of a RADIUS authentication service.
Body
{
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
}
Schema
{
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
}
204
Modify - User Traffic Profile Mapping ¶
PATCH/v6_1/services/auth/radius/{id}/mappings
Use this API command to modify user traffic profile mapping of a RADIUS authentication service.
Body
[
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
Schema
{
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
204
Disable Secondary RADIUS Server of Authentication Service ¶
DELETE/v6_1/services/auth/radius/{id}/secondary
Use this API command to disable secondary RADIUS server of a RADIUS authentication service.
204
Delete - RADIUS Authentication Service ¶
DELETE/v6_1/services/auth/radius/{id}
Use this API command to delete a RADIUS authentication service.
204
Retrieve List - AD Authentication Service by query criteria ¶
POST/v6_1/services/auth/ad/query
Use this API command to retrieve a list of AD Authentication services by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "49322250-6afd-11e4-832a-dc6020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "userDomainId",
"protocol": "AD",
"name": "rapheal-ad",
"friendlyName": "",
"description": "",
"mappings": [
{
"id": "c7608860-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
],
"ip": "1.1.1.1",
"port": 3268,
"windowsDomainName": "dc=domain",
"adminDomainName": "[email protected]",
"password": "abced",
"globalCatalogEnabled": true
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for AD authentication service",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the active directory authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"AD"
]
},
"type": {
"description": "Authentication protocol.",
"enum": [
"AD"
]
},
"name": {
"description": "Name of the active directory authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"tlsEnabled": {
"description": "AD over TLS Enabled",
"type": "boolean"
},
"globalCatalogEnabled": {
"description": "Global catalog support enabled or disabled",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve List - Active Directory Authentication Service ¶
GET/v6_1/services/auth/ad
Use this API command to retrieve a list of active directory authentication services.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "49322250-6afd-11e4-832a-dc6020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "userDomainId",
"protocol": "AD",
"name": "rapheal-ad",
"friendlyName": "",
"description": "",
"mappings": [
{
"id": "c7608860-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
],
"ip": "1.1.1.1",
"port": 3268,
"windowsDomainName": "dc=domain",
"adminDomainName": "[email protected]",
"password": "abced",
"globalCatalogEnabled": true
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for AD authentication service",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the active directory authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"AD"
]
},
"type": {
"description": "Authentication protocol.",
"enum": [
"AD"
]
},
"name": {
"description": "Name of the active directory authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"tlsEnabled": {
"description": "AD over TLS Enabled",
"type": "boolean"
},
"globalCatalogEnabled": {
"description": "Global catalog support enabled or disabled",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve - Active Directory Authentication Service ¶
GET/v6_1/services/auth/ad/{id}
Use this API command to retrieve an active directory authentication service.
200
Body
{
"id": "49322250-6afd-11e4-832a-dc6020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "userDomainId",
"protocol": "AD",
"name": "rapheal-ad",
"friendlyName": "",
"description": "",
"mappings": [
{
"id": "c7608860-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
],
"ip": "1.1.1.1",
"port": 3268,
"windowsDomainName": "dc=domain",
"adminDomainName": "[email protected]",
"password": "abced",
"tlsEnabled": false,
"globalCatalogEnabled": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the active directory authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"AD"
]
},
"type": {
"description": "Authentication protocol.",
"enum": [
"AD"
]
},
"name": {
"description": "Name of the active directory authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"tlsEnabled": {
"description": "AD over TLS Enabled",
"type": "boolean"
},
"globalCatalogEnabled": {
"description": "Global catalog support enabled or disabled",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create - Active Directory Authentication Service ¶
POST/v6_1/services/auth/ad
Use this API command to create a new active directory authentication service.
Body
{
"name": "rapheal-ad2",
"ip": "1.1.1.15",
"port": 389,
"windowsDomainName": "dc=domain",
"globalCatalogEnabled": false,
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"type": {
"description": "Authentication protocol.",
"enum": [
"AD"
]
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the active directory authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"tlsEnabled": {
"description": "AD over TLS Enabled",
"type": "boolean"
},
"globalCatalogEnabled": {
"description": "Global catalog support enabled or disabled",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
},
"required": [
"name",
"ip",
"port",
"windowsDomainName",
"globalCatalogEnabled",
"tlsEnabled"
]
}
201
Body
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify - Active Directory Authentication Service ¶
PATCH/v6_1/services/auth/ad/{id}
Use this API command to modify the basic information of an active directory authentication service.
Body
{
"adminDomainName": "[email protected]",
"password": "newpassword",
"globalCatalogEnabled": true,
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the active directory authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the active directory authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"type": {
"description": "Authentication protocol.",
"enum": [
"AD"
]
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"tlsEnabled": {
"description": "AD over TLS Enabled",
"type": "boolean"
},
"globalCatalogEnabled": {
"description": "Global catalog support enabled or disabled",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Modify - User Traffic Profile Mapping of Active Directory ¶
PATCH/v6_1/services/auth/ad/{id}/mappings
Use this API command to modify user traffic profile mapping of an active directory authentication service.
Body
[
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
Schema
{
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
204
Delete - Active Directory Authentication Service ¶
DELETE/v6_1/services/auth/ad/{id}
Use this API command to delete an active directory authentication service.
204
Retrieve List - LDAP Authentication Service by query criteria ¶
POST/v6_1/services/auth/ldap/query
Use this API command to retrieve a list of LDAP Authentication services by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "18b76a50-6a57-11e4-96af-dc6020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"protocol": "LDAP",
"name": "rapheal-ldap",
"friendlyName": "",
"description": "",
"mappings": [
{
"id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
},
{
"id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "abcd",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
],
"tlsEnabled": true,
"ip": "1.1.1.122",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "uid=ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "(objectClass=*)"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for ldap authentication service",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the LDAP authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the LDAP authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"protocol": {
"description": "Authentication protocol",
"enum": [
"LDAP"
]
},
"type": {
"description": "Authentication protocol same as protocol.",
"enum": [
"LDAP"
]
},
"description": {
"description": "Description of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tlsEnabled": {
"description": "LDAP over TLS Enabled",
"type": "boolean"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve List - LDAP Authentication Service ¶
GET/v6_1/services/auth/ldap
Use this API command to retrieve a list of LDAP authentication services.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "18b76a50-6a57-11e4-96af-dc6020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"protocol": "LDAP",
"name": "rapheal-ldap",
"friendlyName": "",
"description": "",
"mappings": [
{
"id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
},
{
"id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "abcd",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
],
"tlsEnabled": true,
"ip": "1.1.1.122",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "uid=ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "(objectClass=*)"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for ldap authentication service",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the LDAP authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the LDAP authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"protocol": {
"description": "Authentication protocol",
"enum": [
"LDAP"
]
},
"type": {
"description": "Authentication protocol same as protocol.",
"enum": [
"LDAP"
]
},
"description": {
"description": "Description of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tlsEnabled": {
"description": "LDAP over TLS Enabled",
"type": "boolean"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve - LDAP Authentication Service ¶
GET/v6_1/services/auth/ldap/{id}
Use this API command to retrieve a LDAP authentication service.
200
Body
{
"id": "18b76a50-6a57-11e4-96af-dc6020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"protocol": "LDAP",
"name": "rapheal-ldap",
"friendlyName": "",
"description": "",
"mappings": [
{
"id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
},
{
"id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "abcd",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
],
"tlsEnabled": true,
"ip": "1.1.1.122",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "uid=ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "(objectClass=*)"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the LDAP authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the LDAP authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"protocol": {
"description": "Authentication protocol",
"enum": [
"LDAP"
]
},
"type": {
"description": "Authentication protocol same as protocol.",
"enum": [
"LDAP"
]
},
"description": {
"description": "Description of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tlsEnabled": {
"description": "LDAP over TLS Enabled",
"type": "boolean"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create - LDAP Authentication Service ¶
POST/v6_1/services/auth/ldap
Use this API command to create a new LDAP authentication service.
Body
{
"name": "rapheal-ldap",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"tlsEnabled": true,
"ip": "1.1.1.1",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "uid=ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "(objectClass=*)"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the LDAP authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"type": {
"description": "Authentication protocol.",
"enum": [
"LDAP"
]
},
"description": {
"description": "Description of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tlsEnabled": {
"description": "LDAP over TLS Enabled",
"type": "boolean"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
},
"required": [
"name",
"ip",
"port",
"baseDomainName",
"adminDomainName",
"password",
"keyAttribute",
"searchFilter",
"tlsEnabled"
]
}
201
Body
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify - LDAP Authentication Service ¶
PATCH/v6_1/services/auth/ldap/{id}
Use this API command to modify the basic information of a LDAP authentication service.
Body
{
"friendlyName": "new name",
"description": "new description",
"tlsEnabled": true,
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the LDAP authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"type": {
"description": "Authentication protocol same as protocol.",
"enum": [
"LDAP"
]
},
"tlsEnabled": {
"description": "LDAP over TLS Enabled",
"type": "boolean"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Modify - User Traffic Profile Mapping of LDAP ¶
PATCH/v6_1/services/auth/ldap/{id}/mappings
Use this API command to modify user traffic profile mapping of a LDAP authentication service.
Body
[
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
]
Schema
{
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
204
Delete - LDAP Authentication Service ¶
DELETE/v6_1/services/auth/ldap/{id}
Use this API command to delete a LDAP authentication service.
204
Retrieve List - oAuth Authentication Service by query criteria ¶
POST/v6_1/services/auth/oauth/query
Use this API command to retrieve a list of oAuth Authentication services by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c74c5340-ac1b-11e4-8a77-08002716c79f",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "globalOauth",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"protocol": "OAUTH",
"description": "",
"mappings": [
{
"id": "c76bc220-ac1b-11e4-8a77-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
"name": "Default",
"userTrafficProfile": {
"id": "f63a7ad0-8590-11e4-8051-08002716c79f",
"name": "System Default"
}
}
}
],
"type": "FACEBOOK",
"applicationId": "test",
"applicationSecret": "test",
"willCollectEmail": true,
"defaultWhitelistedDomains": [
"fbcdn-profile-a.akamaihd.net",
"fbstatic-a.akamaihd.net",
"www.facebook.com"
],
"whitelistedDomains": [
"*.facebook.com",
"ruckus.com"
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"oauthSpecifiedItems": true,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for oauth authentication service",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the OAuth authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"type": {
"description": "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"name": {
"description": "Name of the OAuth authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the oAuth authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the OAuth authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"applicationId": {
"description": "Application ID",
"type": "string"
},
"applicationSecret": {
"description": "Application Secret",
"type": "string"
},
"willCollectEmail": {
"description": "Will collect user's email address",
"type": "boolean"
},
"defaultWhitelistedDomains": {
"description": "Defualt whitelisted domains",
"type": "array",
"items": {
"type": "string"
}
},
"whitelistedDomains": {
"description": "Customized whitelisted domains",
"type": "array",
"items": {
"description": "admin domain name",
"type": "string"
}
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve List - OAuth Authentication Service ¶
GET/v6_1/services/auth/oauth
Use this API command to retrieve a list of OAuth authentication service.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c74c5340-ac1b-11e4-8a77-08002716c79f",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "globalOauth",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"protocol": "OAUTH",
"description": "",
"mappings": [
{
"id": "c76bc220-ac1b-11e4-8a77-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
"name": "Default",
"userTrafficProfile": {
"id": "f63a7ad0-8590-11e4-8051-08002716c79f",
"name": "System Default"
}
}
}
],
"type": "FACEBOOK",
"applicationId": "test",
"applicationSecret": "test",
"willCollectEmail": true,
"defaultWhitelistedDomains": [
"fbcdn-profile-a.akamaihd.net",
"fbstatic-a.akamaihd.net",
"www.facebook.com"
],
"whitelistedDomains": [
"*.facebook.com",
"ruckus.com"
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"oauthSpecifiedItems": true,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for oauth authentication service",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the OAuth authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"type": {
"description": "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"name": {
"description": "Name of the OAuth authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the oAuth authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the OAuth authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"applicationId": {
"description": "Application ID",
"type": "string"
},
"applicationSecret": {
"description": "Application Secret",
"type": "string"
},
"willCollectEmail": {
"description": "Will collect user's email address",
"type": "boolean"
},
"defaultWhitelistedDomains": {
"description": "Defualt whitelisted domains",
"type": "array",
"items": {
"type": "string"
}
},
"whitelistedDomains": {
"description": "Customized whitelisted domains",
"type": "array",
"items": {
"description": "admin domain name",
"type": "string"
}
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve - OAuth Authentication Service ¶
GET/v6_1/services/auth/oauth/{id}
Use this API command to retrieve a OAuth authentication service.
200
Body
{
"id": "c74c5340-ac1b-11e4-8a77-08002716c79f",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"protocol": "OAUTH",
"name": "globalOauth",
"description": "",
"mappings": [
{
"id": "c76bc220-ac1b-11e4-8a77-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
"name": "Default",
"userTrafficProfile": {
"id": "f63a7ad0-8590-11e4-8051-08002716c79f",
"name": "System Default"
}
}
}
],
"type": "FACEBOOK",
"applicationId": "test",
"applicationSecret": "test",
"willCollectEmail": true,
"defaultWhitelistedDomains": [
"fbcdn-profile-a.akamaihd.net",
"fbstatic-a.akamaihd.net",
"*.facebook.com"
],
"whitelistedDomains": [
"ruckus.com"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the OAuth authentication service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"type": {
"description": "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"name": {
"description": "Name of the OAuth authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the oAuth authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the OAuth authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"applicationId": {
"description": "Application ID",
"type": "string"
},
"applicationSecret": {
"description": "Application Secret",
"type": "string"
},
"willCollectEmail": {
"description": "Will collect user's email address",
"type": "boolean"
},
"defaultWhitelistedDomains": {
"description": "Defualt whitelisted domains",
"type": "array",
"items": {
"type": "string"
}
},
"whitelistedDomains": {
"description": "Customized whitelisted domains",
"type": "array",
"items": {
"description": "admin domain name",
"type": "string"
}
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create - OAuth Authentication Service ¶
POST/v6_0/services/auth/oauth
Use this API command to create a new OAuth authentication service.
Deprecated : this URI will be deprecated after Version: v6_0, not support.
Body
{
"type": "GOOGLE",
"name": "globalOauth",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"description": "create oAuthAuthentication desc",
"mappings": [
{
"groupAttr": "*",
"userRole": {
"name": "Default"
}
}
],
"applicationId": "test",
"applicationSecret": "test",
"willCollectEmail": true,
"whitelistedDomains": [
"ruckus.com"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"type": {
"description": "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"name": {
"description": "Name of the OAuth authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the OAuth authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"applicationId": {
"description": "Application ID",
"type": "string"
},
"applicationSecret": {
"description": "Application Secret",
"type": "string"
},
"willCollectEmail": {
"description": "Will collect user's email address",
"type": "boolean"
},
"whitelistedDomains": {
"description": "Admin domain name",
"type": "array",
"items": {
"type": "string"
}
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
},
"required": [
"type",
"name",
"applicationId",
"applicationSecret",
"willCollectEmail"
]
}
201
Body
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify - OAuth Authentication Service ¶
PATCH/v6_1/services/auth/oauth/{id}
Use this API command to modify the basic information of an OAuth authentication service.
Body
{
"name": "globalOauth",
"description": "modify oAuthAuthentication desc",
"mappings": [
{
"groupAttr": "*",
"userRole": {
"name": "Default"
}
}
],
"applicationId": "test",
"applicationSecret": "test",
"willCollectEmail": true,
"whitelistedDomains": [
"ruckus.com"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the OAuth authentication service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"friendlyName": {
"description": "Friendly name of the LDAP authentication service",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"description": {
"description": "Description of the OAuth authentication service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"protocol": {
"description": "Authentication protocol.",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"type": {
"description": "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
"enum": [
"FACEBOOK",
"GOOGLE",
"LINKEDIN"
]
},
"applicationId": {
"description": "Application ID",
"type": "string"
},
"applicationSecret": {
"description": "Application Secret",
"type": "string"
},
"willCollectEmail": {
"description": "Will collect user's email address",
"type": "boolean"
},
"whitelistedDomains": {
"description": "Admin domain name",
"type": "array",
"items": {
"type": "string"
}
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
}
}
204
Modify - Whitelisted Domains of OAuth ¶
PATCH/v6_1/services/auth/oauth/{id}/whitelistedDomains
Use this API command to modify whitelisted domains of an OAuth authentication service.
Body
[
"ruckus.com"
]
Schema
{
"description": "Admin domain name",
"type": "array",
"items": {
"type": "string"
}
}
204
Modify - User Traffic Profile Mapping of OAuth ¶
PATCH/v6_1/services/auth/oauth/{id}/mappings
Use this API command to modify user traffic profile mapping of an OAuth authentication service.
Body
[
{
"groupAttr": "*",
"userRole": {
"name": "Default"
}
}
]
Schema
{
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
}
204
Accounting Service ¶
Retrieve List - All types of Accounting Service by query criteria ¶
POST/v6_1/services/acct/query
Use this API command to retrieve a list of accounting services by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "CGF",
"description": "",
"protocol": "CGF",
"type": "CGF",
"createDateTime": 1486092683212,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486095333155,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
},
{
"id": "a7bb3550-e9c2-11e6-b761-64006a6a50c6",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "rad",
"description": "",
"protocol": "RADIUS",
"type": "RADIUS",
"createDateTime": 1486093292837,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486093292837,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for accounting servers",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the accounting service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "Name of the accounting service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the accounting service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"protocol": {
"description": "Accounting protocol.",
"enum": [
"RADIUS",
"CGF"
]
},
"type": {
"description": "Accounting protocol same as protocol.",
"enum": [
"RADIUS",
"CGF"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Delete Accounting Service ¶
Delete a list of Accounting Service ¶
DELETE/v6_1/services/acct
Use this API command to delete a list of accounting service.
Body
{
"idList": [
"839f87c6-d116-497e-afce-aa8157abdasd"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Test specific Accounting Service ¶
POST/v6_1/services/acct/test/{id}
Use this API command to test an accounting service.
Body
{
"id": "839f87c6-d116-497e-afce-aa8157abdasd",
"loginRequest": {
"password": "adsf",
"userName": "test",
"timeZoneUtcOffset": "+8",
"protocol": ""
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication service",
"type": "string"
},
"loginRequest": {
"type": "object",
"properties": {
"password": {
"description": "password for test user",
"type": "string"
},
"userName": {
"description": "name for test user",
"type": "string"
},
"timeZoneUtcOffset": {
"description": "timezone offset, ex: '+8'",
"type": "string"
},
"protocol": {
"description": "",
"type": "string"
}
}
}
}
}
200
Retrieve List - Radius Accounting Service by query criteria ¶
POST/v6_1/services/acct/radius/query
Use this API command to retrieve a list of Radius accounting services by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "accountingServiceUUID",
"mvnoId": "userMVNOId",
"domainId": "userDomainId",
"name": "accountingServiceName",
"protocol": "RADIUS",
"description": "accountingServiceDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"healthCheckPolicy": {
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
},
"rateLimiting": {
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for radius accounting server",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS accounting service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"type": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"name": {
"description": "Name of the RADIUS accounting service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS accounting service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve List - RADIUS Accounting Service ¶
GET/v6_1/services/acct/radius
Use this API command to retrieve a list of RADIUS accounting services.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "accountingServiceUUID",
"mvnoId": "userMVNOId",
"domainId": "userDomainId",
"name": "accountingServiceName",
"protocol": "RADIUS",
"description": "accountingServiceDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"healthCheckPolicy": {
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
},
"rateLimiting": {
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for radius accounting server",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS accounting service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"type": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"name": {
"description": "Name of the RADIUS accounting service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS accounting service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve - RADIUS Accounting Service ¶
GET/v6_1/services/acct/radius/{id}
Use this API command to retrieve a RADIUS accounting service.
200
Body
{
"id": "accountingServiceUUID",
"mvnoId": "userMVNOId",
"domainId": "userDomainId",
"protocol": "RADIUS",
"name": "accountingServiceName",
"description": "accountingServiceDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"healthCheckPolicy": {
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
},
"rateLimiting": {
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS accounting service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"type": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"name": {
"description": "Name of the RADIUS accounting service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS accounting service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create - RADIUS Accounting Service ¶
POST/v6_1/services/acct/radius
Use this API command to create a new RADIUS accounting service.
Body
{
"name": "accountingServiceName",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"primary": {
"ip": "192.168.1.1",
"port": 1813,
"sharedSecret": "sharedSecret"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the RADIUS accounting service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"type": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"description": {
"description": "Description of the RADIUS accounting service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
}
},
"required": [
"name",
"primary"
]
}
201
Body
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify - RADIUS Accounting Service ¶
PATCH/v6_1/services/acct/radius/{id}
Use this API command to modify the basic information of a RADIUS accounting service.
Body
{
"name": "new name",
"description": "new description",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"healthCheckPolicy": {
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
},
"rateLimiting": {
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS accounting service",
"type": "string"
},
"name": {
"description": "Name of the RADIUS accounting service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"protocol": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"type": {
"description": "Accounting protocol.",
"enum": [
"RADIUS"
]
},
"description": {
"description": "Description of the RADIUS accounting service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
},
"healthCheckPolicy": {
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
},
"rateLimiting": {
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
}
}
}
204
Modify - Primary RADIUS Server of Accounting Service ¶
PATCH/v6_1/services/acct/radius/{id}/primary
Use this API command to modify primary RADIUS server of a RADIUS accounting service.
Body
{
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
}
Schema
{
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}
204
Modify - Secondary RADIUS Server of Accounting Service ¶
PATCH/v6_1/services/acct/radius/{id}/secondary
Use this API command to modify secondary RADIUS server of a RADIUS accounting service.
Body
{
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
}
Schema
{
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"autoFallbackDisable": {
"description": "Automatic fallback enabled or disabled",
"type": "boolean"
},
"ip": {
"description": "RADIUS server IP",
"type": "string"
},
"port": {
"description": "RADIUS server port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 1812
},
"sharedSecret": {
"description": "RADIUS server shared secrect",
"type": "string"
}
},
"required": [
"autoFallbackDisable",
"ip",
"port",
"sharedSecret"
]
}
204
Modify - Rate Limiting of Accounting Service ¶
PATCH/v6_1/services/acct/radius/{id}/rateLimiting
Use this API command to modify rate limiting of a RADIUS accounting service.
Body
{
"maxOutstandingRequestsPerServer": 0,
"threshold": 0,
"sanityTimer": 10
}
Schema
{
"description": "Rate limiting",
"type": "object",
"additionalProperties": false,
"properties": {
"maxOutstandingRequestsPerServer": {
"description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type": "integer",
"default": 0
},
"threshold": {
"description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type": "integer",
"default": 0
},
"sanityTimer": {
"description": "Sanity timer",
"type": "integer",
"minimum": 1,
"maximum": 3600,
"default": 10
}
},
"required": [
"maxOutstandingRequestsPerServer",
"threshold",
"sanityTimer"
]
}
204
Modify - Health Check Policy of Accounting Service ¶
PATCH/v6_1/services/acct/radius/{id}/healthCheckPolicy
Use this API command to modify health check policy of a RADIUS accounting service.
Body
{
"responseWindow": 20,
"reviveInterval": 120,
"zombiePeriod": 40
}
Schema
{
"description": "Health check policy",
"type": "object",
"additionalProperties": false,
"properties": {
"responseWindow": {
"description": "Response window",
"type": "integer",
"minimum": 5,
"maximum": 30,
"default": 20
},
"reviveInterval": {
"description": "Revive interval",
"type": "integer",
"minimum": 60,
"maximum": 3600,
"default": 120
},
"zombiePeriod": {
"description": "Zombie period",
"type": "integer",
"minimum": 30,
"maximum": 120,
"default": 40
},
"responseFail": {
"description": "Response Fail",
"type": "boolean",
"default": "false"
}
},
"required": [
"responseWindow",
"reviveInterval",
"zombiePeriod"
]
}
204
User Traffic Profile ¶
Retrieve List - User Traffic Profile by query criteria ¶
POST/v6_1/profiles/utp/query
Use this API command to retrieve a list of User Traffic Profile by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "f79b7400-dd6e-11e6-8486-64006a6a50c6",
"name": "123",
"description": "",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"defaultAction": "ALLOW",
"appPolicyId": "",
"urlFilteringPolicyId": "",
"ipAclRules": [
{
"priority": 1,
"uplinkRateLimitingEnabled": null,
"downlinkRateLimitingEnabled": null,
"uplinkRateLimitingMbps": null,
"downlinkRateLimitingMbps": null,
"description": "Allow DNS",
"enableSourceIpSubnet": false,
"sourceIp": null,
"sourceIpMask": null,
"enableDestinationIpSubnet": false,
"destinationIp": null,
"destinationIpMask": null,
"enableSourcePortRange": true,
"sourceMinPort": null,
"sourceMaxPort": null,
"enableDestinationPortRange": false,
"destinationMinPort": 53,
"destinationMaxPort": null,
"protocol": null,
"action": "ALLOW",
"direction": "UPSTREAM"
},
{
"priority": 2,
"uplinkRateLimitingEnabled": null,
"downlinkRateLimitingEnabled": null,
"uplinkRateLimitingMbps": null,
"downlinkRateLimitingMbps": null,
"description": "Allow DHCP",
"enableSourceIpSubnet": false,
"sourceIp": null,
"sourceIpMask": null,
"enableDestinationIpSubnet": false,
"destinationIp": null,
"destinationIpMask": null,
"enableSourcePortRange": true,
"sourceMinPort": null,
"sourceMaxPort": null,
"enableDestinationPortRange": false,
"destinationMinPort": 67,
"destinationMaxPort": null,
"protocol": null,
"action": "ALLOW",
"direction": "UPSTREAM"
}
],
"uplinkRateLimiting": {
"uplinkRateLimitingEnabled": false,
"uplinkRateLimitingBps": null
},
"downlinkRateLimiting": {
"downlinkRateLimitingEnabled": false,
"downlinkRateLimitingBps": null
},
"isFactoryDefault": false,
"createDateTime": 1484737935168,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1484737935168,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
},
{
"id": "86b77cc1-dd46-11e6-bfbb-64006a6a50c6",
"name": "System Default",
"description": "System default traffic profile allows all traffic",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"defaultAction": "ALLOW",
"appPolicyId": "",
"urlFilteringPolicyId": "",
"ipAclRules": [],
"uplinkRateLimiting": null,
"downlinkRateLimiting": null,
"isFactoryDefault": true,
"createDateTime": 1484720565900,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1484720565901,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"type" : "integer"
},
"hasMore" : {
"type" : "boolean"
},
"firstIndex" : {
"type" : "integer"
},
"extra" : {
"description" : "extra information for User Traffic profile",
"type" : "object",
"properties" : {
"rbacMetadata" : {
"type" : "array",
"items" : {
"additionalProperties" : {
"type" : "string"
}
}
}
}
},
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the user traffic profile",
"type" : "string"
},
"name" : {
"description" : "Name of the user traffic profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the user traffic profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"defaultAction" : {
"description" : "Default action",
"default" : "ALLOW",
"enum" : [ "BLOCK", "ALLOW" ]
},
"uplinkRateLimiting" : {
"description" : "Uplink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"uplinkRateLimitingBps" : {
"description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
},
"downlinkRateLimiting" : {
"description" : "Downlink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"downlinkRateLimitingBps" : {
"description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
},
"ipAclRules" : {
"type" : "array",
"description" : "Traffic access control list",
"items" : {
"type" : "object",
"description" : "Traffic access control list",
"additionalProperties" : false,
"properties" : {
"priority" : {
"type" : "integer",
"description" : "Priority"
},
"description" : {
"description" : "Description of the traffic access control rule",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled",
"type" : "boolean"
},
"uplinkRateLimitingMbps" : {
"description" : "Uplink rate limiting",
"type" : "number"
},
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled",
"type" : "boolean"
},
"downlinkRateLimitingMbps" : {
"description" : "Downlink rate limiting",
"type" : "number"
},
"enableSourceIpSubnet" : {
"description" : "Source IP subnet enabled or disabled",
"type" : "boolean"
},
"sourceIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of source IP."
},
"sourceIpMask" : {
"type" : "string",
"description" : "Subnet mask of source IP"
},
"enableDestinationIpSubnet" : {
"description" : "Destination IP subnet enabled or disabled",
"type" : "boolean"
},
"destinationIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of destination IP."
},
"destinationIpMask" : {
"type" : "string",
"description" : "Subnet mask of destination IP"
},
"enableSourcePortRange" : {
"description" : "Source port range enabled or disabled",
"type" : "boolean"
},
"sourceMinPort" : {
"type" : "integer",
"description" : "The minunum port of source port range."
},
"sourceMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of source port range."
},
"enableDestinationPortRange" : {
"description" : "Destincation port range enabled or disabled",
"type" : "boolean"
},
"destinationMinPort" : {
"type" : "integer",
"description" : "The mininum port of destination port range."
},
"destinationMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of destination port range."
},
"protocol" : {
"description" : "The protocol of traffic access control.",
"enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
},
"action" : {
"description" : "The access of traffic access control.",
"default" : "ALLOW",
"enum" : [ "ALLOW", "BLOCK" ]
},
"direction" : {
"description" : "The direction of traffic access control.",
"default" : "UPSTREAM",
"enum" : [ "UPSTREAM" ]
}
}
}
},
"appPolicyId" : {
"description" : "Application Policy UUID",
"type" : "string"
},
"urlFilteringPolicyId" : {
"description" : "URL Filtering Policy UUID",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"domainId" : {
"description" : "Domain UUID",
"type" : "string"
},
"isFactoryDefault" : {
"description" : "Whether the UTP is factory default or not"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
}
}
}
}
}
Retrieve List - User Traffic Profile ¶
GET/v6_1/profiles/utp
Use this API command to retrieve a list of user traffic profile.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"name": "new name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve - User Traffic Profile ¶
GET/v6_1/profiles/utp/{id}
Use this API command to retrieve an user traffic profile.
200
Body
{
"id": "1869c000-9c5e-11e4-9d3a-00606eb0c700",
"name": "user-traffic-profile-name",
"description": "user traffic profile description",
"defaultAction": "ALLOW",
"ipAclRules": [
{
"priority": 1,
"description": "Allow DNS",
"uplinkRateLimiting": {
"uplinkRateLimitingEnabled": true,
"uplinkRateLimitingBps": "0.50"
},
"downlinkRateLimiting": {
"downlinkRateLimitingEnabled": true,
"downlinkRateLimitingBps": "0.50"
},
"enableSourceIpSubnet": true,
"sourceIp": "172.17.26.50",
"sourceIpMask": "255.255.0.0",
"enableDestinationIpSubnet": true,
"destinationIp": "172.17.29.31",
"destinationIpMask": "255.255.255.0",
"enableSourcePortRange": true,
"sourceMinPort": 10,
"sourceMaxPort": 65530,
"enableDestinationPortRange": false,
"destinationMinPort": 53,
"destinationMaxPort": null,
"protocol": null,
"action": "ALLOW",
"direction": "UPSTREAM"
},
{
"priority": 2,
"description": "Allow DHCP",
"enableSourceIpSubnet": false,
"sourceIp": "172.17.51.99",
"sourceIpMask": "",
"enableDestinationIpSubnet": false,
"destinationIp": "172.17.53.99",
"destinationIpMask": "",
"enableSourcePortRange": true,
"sourceMinPort": null,
"sourceMaxPort": null,
"enableDestinationPortRange": false,
"destinationMinPort": 67,
"destinationMaxPort": null,
"protocol": null,
"action": "ALLOW",
"direction": "UPSTREAM"
}
],
"uplinkRateLimiting": {
"uplinkRateLimitingEnabled": true,
"uplinkRateLimitingBps": "2.75 mbps"
},
"downlinkRateLimiting": {
"downlinkRateLimitingEnabled": true,
"downlinkRateLimitingBps": "2.00 mbps"
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the user traffic profile",
"type" : "string"
},
"name" : {
"description" : "Name of the user traffic profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the user traffic profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"defaultAction" : {
"description" : "Default action",
"default" : "ALLOW",
"enum" : [ "BLOCK", "ALLOW" ]
},
"uplinkRateLimiting" : {
"description" : "Uplink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"uplinkRateLimitingBps" : {
"description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
},
"downlinkRateLimiting" : {
"description" : "Downlink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"downlinkRateLimitingBps" : {
"description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
},
"ipAclRules" : {
"type" : "array",
"description" : "Traffic access control list",
"items" : {
"type" : "object",
"description" : "Traffic access control list",
"additionalProperties" : false,
"properties" : {
"priority" : {
"type" : "integer",
"description" : "Priority"
},
"description" : {
"description" : "Description of the traffic access control rule",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled",
"type" : "boolean"
},
"uplinkRateLimitingMbps" : {
"description" : "Uplink rate limiting",
"type" : "number"
},
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled",
"type" : "boolean"
},
"downlinkRateLimitingMbps" : {
"description" : "Downlink rate limiting",
"type" : "number"
},
"enableSourceIpSubnet" : {
"description" : "Source IP subnet enabled or disabled",
"type" : "boolean"
},
"sourceIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of source IP."
},
"sourceIpMask" : {
"type" : "string",
"description" : "Subnet mask of source IP"
},
"enableDestinationIpSubnet" : {
"description" : "Destination IP subnet enabled or disabled",
"type" : "boolean"
},
"destinationIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of destination IP."
},
"destinationIpMask" : {
"type" : "string",
"description" : "Subnet mask of destination IP"
},
"enableSourcePortRange" : {
"description" : "Source port range enabled or disabled",
"type" : "boolean"
},
"sourceMinPort" : {
"type" : "integer",
"description" : "The minunum port of source port range."
},
"sourceMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of source port range."
},
"enableDestinationPortRange" : {
"description" : "Destincation port range enabled or disabled",
"type" : "boolean"
},
"destinationMinPort" : {
"type" : "integer",
"description" : "The mininum port of destination port range."
},
"destinationMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of destination port range."
},
"protocol" : {
"description" : "The protocol of traffic access control.",
"enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
},
"action" : {
"description" : "The access of traffic access control.",
"default" : "ALLOW",
"enum" : [ "ALLOW", "BLOCK" ]
},
"direction" : {
"description" : "The direction of traffic access control.",
"default" : "UPSTREAM",
"enum" : [ "UPSTREAM" ]
}
}
}
},
"appPolicyId" : {
"description" : "Application Policy UUID",
"type" : "string"
},
"urlFilteringPolicyId" : {
"description" : "URL Filtering Policy UUID",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"domainId" : {
"description" : "Domain UUID",
"type" : "string"
},
"isFactoryDefault" : {
"description" : "Whether the UTP is factory default or not"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
}
}
Create - User Traffic Profile ¶
POST/v6_1/profiles/utp
Use this API command to create a new user traffic profile.
Body
{
"name": "user-traffic-profile-name",
"description": "User traffic profile description",
"defaultAction": "ALLOW",
"uplinkRateLimiting": {
"uplinkRateLimitingEnabled": true,
"uplinkRateLimitingBps": "2.75 mbps"
},
"downlinkRateLimiting": {
"downlinkRateLimitingEnabled": true,
"downlinkRateLimitingBps": "2.00 mbps"
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the user traffic profile",
"minLength" : 2,
"maxLength" : 32,
"type" : "string",
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the user traffic profile",
"maxLength" : 64,
"type" : [ "string", "null" ]
},
"defaultAction" : {
"description" : "Default action",
"default" : "ALLOW",
"enum" : [ "BLOCK", "ALLOW" ]
},
"uplinkRateLimiting" : {
"description" : "Uplink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"uplinkRateLimitingBps" : {
"description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
},
"downlinkRateLimiting" : {
"description" : "Downlink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"downlinkRateLimitingBps" : {
"description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
},
"ipAclRules" : {
"type" : "array",
"description" : "Traffic access control list",
"items" : {
"type" : "object",
"description" : "Traffic access control list",
"additionalProperties" : false,
"properties" : {
"priority" : {
"type" : "integer",
"description" : "Priority"
},
"description" : {
"description" : "Description of the traffic access control rule",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled",
"type" : "boolean"
},
"uplinkRateLimitingMbps" : {
"description" : "Uplink rate limiting",
"type" : "number"
},
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled",
"type" : "boolean"
},
"downlinkRateLimitingMbps" : {
"description" : "Downlink rate limiting",
"type" : "number"
},
"enableSourceIpSubnet" : {
"description" : "Source IP subnet enabled or disabled",
"type" : "boolean"
},
"sourceIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of source IP."
},
"sourceIpMask" : {
"type" : "string",
"description" : "Subnet mask of source IP"
},
"enableDestinationIpSubnet" : {
"description" : "Destination IP subnet enabled or disabled",
"type" : "boolean"
},
"destinationIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of destination IP."
},
"destinationIpMask" : {
"type" : "string",
"description" : "Subnet mask of destination IP"
},
"enableSourcePortRange" : {
"description" : "Source port range enabled or disabled",
"type" : "boolean"
},
"sourceMinPort" : {
"type" : "integer",
"description" : "The minunum port of source port range."
},
"sourceMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of source port range."
},
"enableDestinationPortRange" : {
"description" : "Destincation port range enabled or disabled",
"type" : "boolean"
},
"destinationMinPort" : {
"type" : "integer",
"description" : "The mininum port of destination port range."
},
"destinationMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of destination port range."
},
"protocol" : {
"description" : "The protocol of traffic access control.",
"enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
},
"action" : {
"description" : "The access of traffic access control.",
"default" : "ALLOW",
"enum" : [ "ALLOW", "BLOCK" ]
},
"direction" : {
"description" : "The direction of traffic access control.",
"default" : "UPSTREAM",
"enum" : [ "UPSTREAM" ]
}
}
}
},
"appPolicyId" : {
"description" : "Application Policy UUID",
"type" : "string"
},
"urlFilteringPolicyId" : {
"description" : "URL Filtering Policy UUID",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"domainId" : {
"description" : "Domain UUID",
"type" : "string"
}
},
"required" : [ "name", "defaultAction" ]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify - User Traffic Profile ¶
PATCH/v6_1/profiles/utp/{id}
Use this API command to modify the basic information of user traffic profile.
Body
{
"name": "new-user-traffic-profile-name",
"description": "user traffic profile description",
"defaultAction": "ALLOW",
"uplinkRateLimiting": {
"uplinkRateLimitingEnabled": true,
"uplinkRateLimitingBps": "0.10 mbps"
},
"downlinkRateLimiting": {
"downlinkRateLimitingEnabled": true,
"downlinkRateLimitingBps": "0.10 mbps"
},
"ipAclRules": [
{
"description": "acl rule description",
"uplinkRateLimiting": {
"uplinkRateLimitingEnabled": true,
"uplinkRateLimitingBps": "0.50"
},
"downlinkRateLimiting": {
"downlinkRateLimitingEnabled": true,
"downlinkRateLimitingBps": "0.50"
},
"enableSourceIpSubnet": true,
"sourceIp": "172.17.26.55",
"sourceIpMask": "255.255.255.0",
"enableSourcePortRange": false,
"sourceMinPort": 89,
"enableDestinationPortRange": false,
"destinationIp": "172.17.26.60",
"destinationIpMask": "255.255.0.0",
"protocol": "TCP",
"action": "ALLOW",
"direction": "UPSTREAM"
},
{
"description": "acl rule description",
"enableSourceIpSubnet": true,
"sourceIp": "255.17.26.87",
"sourceIpMask": "255.255.255.0",
"destinationIp": "172.17.26.69",
"destinationIpMask": "255.255.0.0",
"protocol": "UDP",
"action": "BLOCK",
"direction": "UPSTREAM"
}
]
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the user traffic profile",
"type" : "string"
},
"name" : {
"description" : "Name of the user traffic profile",
"minLength" : 2,
"maxLength" : 32,
"type" : "string",
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the user traffic profile",
"maxLength" : 64,
"type" : [ "string", "null" ]
},
"defaultAction" : {
"description" : "Default action",
"default" : "ALLOW",
"enum" : [ "BLOCK", "ALLOW" ]
},
"uplinkRateLimiting" : {
"description" : "Uplink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"uplinkRateLimitingBps" : {
"description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
},
"downlinkRateLimiting" : {
"description" : "Downlink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"downlinkRateLimitingBps" : {
"description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
},
"ipAclRules" : {
"type" : "array",
"description" : "Traffic access control list",
"items" : {
"type" : "object",
"description" : "Traffic access control list",
"additionalProperties" : false,
"properties" : {
"priority" : {
"type" : "integer",
"description" : "Priority"
},
"description" : {
"description" : "Description of the traffic access control rule",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled",
"type" : "boolean"
},
"uplinkRateLimitingMbps" : {
"description" : "Uplink rate limiting",
"type" : "number"
},
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled",
"type" : "boolean"
},
"downlinkRateLimitingMbps" : {
"description" : "Downlink rate limiting",
"type" : "number"
},
"enableSourceIpSubnet" : {
"description" : "Source IP subnet enabled or disabled",
"type" : "boolean"
},
"sourceIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of source IP."
},
"sourceIpMask" : {
"type" : "string",
"description" : "Subnet mask of source IP"
},
"enableDestinationIpSubnet" : {
"description" : "Destination IP subnet enabled or disabled",
"type" : "boolean"
},
"destinationIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of destination IP."
},
"destinationIpMask" : {
"type" : "string",
"description" : "Subnet mask of destination IP"
},
"enableSourcePortRange" : {
"description" : "Source port range enabled or disabled",
"type" : "boolean"
},
"sourceMinPort" : {
"type" : "integer",
"description" : "The minunum port of source port range."
},
"sourceMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of source port range."
},
"enableDestinationPortRange" : {
"description" : "Destincation port range enabled or disabled",
"type" : "boolean"
},
"destinationMinPort" : {
"type" : "integer",
"description" : "The mininum port of destination port range."
},
"destinationMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of destination port range."
},
"protocol" : {
"description" : "The protocol of traffic access control.",
"enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
},
"action" : {
"description" : "The access of traffic access control.",
"default" : "ALLOW",
"enum" : [ "ALLOW", "BLOCK" ]
},
"direction" : {
"description" : "The direction of traffic access control.",
"default" : "UPSTREAM",
"enum" : [ "UPSTREAM" ]
}
},
"required" : [ "action", "direction" ]
}
},
"appPolicyId" : {
"description" : "Application Policy UUID",
"type" : "string"
},
"urlFilteringPolicyId" : {
"description" : "URL Filtering Policy UUID",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"domainId" : {
"description" : "Domain UUID",
"type" : "string"
}
}
}
204
Modify - IpAclRules ¶
PATCH/v6_1/profiles/utp/{id}/ipAclRules
Use this API command to modify IP ACL rules of user traffic profile.
Body
[
{
"description": "acl rule description",
"uplinkRateLimiting": {
"uplinkRateLimitingEnabled": true,
"uplinkRateLimitingBps": "0.50"
},
"downlinkRateLimiting": {
"downlinkRateLimitingEnabled": true,
"downlinkRateLimitingBps": "0.50"
},
"enableSourceIpSubnet": true,
"sourceIp": "172.17.26.55",
"sourceIpMask": "255.255.255.0",
"enableSourcePortRange": false,
"sourceMinPort": 89,
"enableDestinationPortRange": false,
"destinationIp": "172.17.26.60",
"destinationIpMask": "255.255.0.0",
"protocol": "TCP",
"action": "ALLOW",
"direction": "UPSTREAM"
},
{
"description": "acl rule description",
"enableSourceIpSubnet": true,
"sourceIp": "255.17.26.87",
"sourceIpMask": "255.255.255.0",
"destinationIp": "172.17.26.69",
"destinationIpMask": "255.255.0.0",
"protocol": "UDP",
"action": "BLOCK",
"direction": "UPSTREAM"
}
]
Schema
{
"type": "array",
"description": "Traffic access control list",
"items": {
"type": "object",
"description": "Traffic access control list",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"description": {
"description": "Description of the traffic access control rule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"uplinkRateLimitingEnabled": {
"description": "Uplink rate limiting enabled",
"type": "boolean"
},
"uplinkRateLimitingMbps": {
"description": "Uplink rate limiting",
"type": "number"
},
"downlinkRateLimitingEnabled": {
"description": "Downlink rate limiting enabled",
"type": "boolean"
},
"downlinkRateLimitingMbps": {
"description": "Downlink rate limiting",
"type": "number"
},
"enableSourceIpSubnet": {
"description": "Source IP subnet enabled or disabled",
"type": "boolean"
},
"sourceIp": {
"type": "string",
"description": "Subnet network address or ip address of source IP."
},
"sourceIpMask": {
"type": "string",
"description": "Subnet mask of source IP"
},
"enableDestinationIpSubnet": {
"description": "Destination IP subnet enabled or disabled",
"type": "boolean"
},
"destinationIp": {
"type": "string",
"description": "Subnet network address or ip address of destination IP."
},
"destinationIpMask": {
"type": "string",
"description": "Subnet mask of destination IP"
},
"enableSourcePortRange": {
"description": "Source port range enabled or disabled",
"type": "boolean"
},
"sourceMinPort": {
"type": "integer",
"description": "The minunum port of source port range."
},
"sourceMaxPort": {
"type": "integer",
"description": "The maxinum port of source port range."
},
"enableDestinationPortRange": {
"description": "Destincation port range enabled or disabled",
"type": "boolean"
},
"destinationMinPort": {
"type": "integer",
"description": "The mininum port of destination port range."
},
"destinationMaxPort": {
"type": "integer",
"description": "The maxinum port of destination port range."
},
"protocol": {
"description": "The protocol of traffic access control.",
"enum": [
"TCP",
"UDP",
"UDPLITE",
"ICMP_ICMPV4",
"ICMPV6",
"IGMP",
"ESP",
"AH",
"SCTP"
]
},
"action": {
"description": "The access of traffic access control.",
"default": "ALLOW",
"enum": [
"ALLOW",
"BLOCK"
]
},
"direction": {
"description": "The direction of traffic access control.",
"default": "UPSTREAM",
"enum": [
"UPSTREAM"
]
}
},
"required": [
"action",
"direction"
]
}
}
204
Modify - uplinkRateLimiting ¶
PATCH/v6_1/profiles/utp/{id}/uplinkRateLimiting
Use this API command to modify uplink rate limiting of user traffic profile.
Body
{
"uplinkRateLimitingEnabled": true,
"uplinkRateLimitingBps": "0.10 mbps"
}
Schema
{
"description" : "Uplink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"uplinkRateLimitingBps" : {
"description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
}
204
Disable - uplinkRateLimiting ¶
DELETE/v6_1/profiles/utp/{id}/uplinkRateLimiting
Use this API command to disable uplink rateLimiting of user traffic profile.
204
Modify - downlinkRateLimiting ¶
PATCH/v6_1/profiles/utp/{id}/downlinkRateLimiting
Use this API command to modify downlink rate limiting of user traffic profile.
Body
{
"downlinkRateLimitingEnabled": true,
"downlinkRateLimitingBps": "0.10 mbps"
}
Schema
{
"description" : "Downlink rate limiting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"downlinkRateLimitingBps" : {
"description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
"type" : "string",
"pattern" : "\S+ mbps$"
}
}
}
204
Disable - downlinkRateLimiting ¶
DELETE/v6_1/profiles/utp/{id}/downlinkRateLimiting
Use this API command to disable downlink rate limiting of user traffic profile.
204
Delete - User Traffic Profile ¶
Delete ¶
DELETE/v6_1/profiles/utp
Use this API command to delete a list of traffic profile.
Body
{
"idList": [
"f79b7400-dd6e-11e6-8486-64006a6a50c6",
"6530a9e1-e9d6-11e6-952e-64006a6a50c6"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Clone ¶
POST/v6_1/profiles/utp/clone/{id}
Use this API command to copy a traffic profile.
Body
{
"oldId": "839f87c6-d116-497e-afce-aa8157abdasd",
"newName": "new name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"oldName": {
"description": "original name",
"type": "string"
},
"oldId": {
"description": "original name",
"type": "string"
},
"newName": {
"description": "Id for new profile",
"type": "string"
},
"newId": {
"description": "name for new profile",
"type": "string"
}
}
}
200
Body
{
"oldId": "839f87c6-d116-497e-afce-aa8157abdasd",
"newId": "fe171501-ad2c-11e5-b656-5254003f0277",
"oldName": "old name",
"newName": "new name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"oldName": {
"description": "original name",
"type": "string"
},
"oldId": {
"description": "original name",
"type": "string"
},
"newName": {
"description": "Id for new profile",
"type": "string"
},
"newId": {
"description": "name for new profile",
"type": "string"
}
}
}
Hotspot Profile ¶
Retrieve List ¶
GET/v6_1/profiles/hotspot
Use this API command to retrieve a list of Hotspot profiles.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"name": "new name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/profiles/hotspot/{id}
Use this API command to retrieve a Hotspot profile.
200
Body
{
"name": "hotspot profile internal",
"id": "aed0c0b7-5358-465f-8091-fa0f26134d53",
"description": "hotspot profile internal description",
"smartClientSupport": "None",
"smartClientInfo": null,
"portalType": "Internal",
"portalUrl": null,
"redirect": null,
"portalCustomization": {
"language": "en_US",
"title": "Ruckus Wireless - Subscriber Portal",
"logo": "logo",
"termsAndConditionsRequired": false
},
"userSession": {
"timeoutInMin": 1440,
"gracePeriodInMin": 60
},
"location": {
"id": "locationId",
"name": "locationName"
},
"macAddressFormat": 2,
"walledGardens": [
"10.11.12.16",
"10.11.12.13"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Hotspot profile",
"type": "string"
},
"name": {
"description": "Name of the Hotspot profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientSupport": {
"description": "SmartClientSupport of the Hotspot profile",
"enum": [
"None",
"Enabled",
"SmartClientOnly"
]
},
"smartClientInfo": {
"description": "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
"type": "string"
},
"portalType": {
"description": "Portal type of the Hotspot profile",
"enum": [
"Internal",
"External"
]
},
"portalUrl": {
"description": "Portal URL of the Hotspot profile",
"type": "string"
},
"location": {
"description": "Location of the Hotspot profile",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot profile",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"portalCustomization": {
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
},
"userSession": {
"description": "User session of the Hotspot profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
}
}
}
Create Internal ¶
POST/v6_1/profiles/hotspot/internal
Use this API command to create a new Hotspot profile with internal logon URL.MacAddressFormat.
Body
{
"name": "test-hotspot222",
"description": "description",
"smartClientSupport": "None",
"location": {
"id": "locationId",
"name": "locationName"
},
"macAddressFormat": 2,
"walledGardens": [
"10.11.12.16",
"10.11.12.13"
],
"httpsRedirect": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientSupport": {
"description": "Smart client support of the Hotspot",
"enum": [
"None",
"Enabled"
]
},
"location": {
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"userSession": {
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
},
"required": [
"name",
"smartClientSupport",
"macAddressFormat"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Create External ¶
POST/v6_1/profiles/hotspot/external
Use this API command to create a new Hotspot profile with external logon URL.MacAddressFormat.
Body
{
"name": "test-hotspot222",
"description": "description",
"smartClientSupport": "None",
"portalUrl": "https://172.17.26.59",
"location": {
"id": "locationId",
"name": "locationName"
},
"macAddressFormat": 2,
"walledGardens": [
"10.11.12.16",
"10.11.12.13"
],
"httpsRedirect": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientSupport": {
"description": "Smart client support of the Hotspot",
"enum": [
"None",
"Enabled"
]
},
"portalUrl": {
"description": "Portal URL of the Hotspot",
"type": "string"
},
"location": {
"description": "Location of the hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"userSession": {
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
},
"required": [
"name",
"smartClientSupport",
"portalUrl",
"macAddressFormat"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Create Smart Client Only ¶
POST/v6_1/profiles/hotspot/smartClientOnly
Use this API command to create a new Hotspot profile with smart client only.MacAddressFormat.
Body
{
"name": "test-hotspot222-smartClientOnly",
"description": "description-smartClientOnly",
"smartClientInfo": "smartClient only, yyyy!",
"location": {
"id": "locationId",
"name": "locationName"
},
"macAddressFormat": 2,
"walledGardens": [
"10.11.12.16",
"10.11.12.13"
],
"httpsRedirect": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientInfo": {
"description": "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
"type": "string"
},
"location": {
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"userSession": {
"description": "Redirect configuration of the Hotspot profile",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
},
"required": [
"name",
"smartClientInfo",
"macAddressFormat"
]
}
201
Body
{
"id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/hotspot/{id}
Use this API command to modify the basic information of a Hotspot profile.MacAddressFormat.
Body
{
"name": "test-hotspot-modify",
"description": "description-modify",
"smartClientSupport": "Enabled",
"portalUrl": "https://172.17.26.59",
"location": {
"id": "locationId",
"name": "locationName"
},
"redirect": {
"url": "https://www.testurl.com"
},
"portalCustomization": {
"language": "en_US",
"title": "Ruckus Wireless - Subscriber Portal",
"logo": "logo",
"termsAndConditionsRequired": false
},
"userSession": {
"timeoutInMin": 1440,
"gracePeriodInMin": 60
},
"macAddressFormat": 2,
"walledGardens": [
"10.1.1.1",
"11.11.111.11"
],
"httpsRedirect": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Hotspot",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Hotspot",
"type": [
"string",
"null"
],
"maxLength": 64
},
"smartClientSupport": {
"description": "Smart client support of the Hotspot",
"enum": [
"None",
"Enabled"
]
},
"smartClientInfo": {
"description": "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
"type": "string"
},
"portalUrl": {
"description": "Portal URL of the Hotspot",
"type": "string"
},
"location": {
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
},
"redirect": {
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
},
"portalCustomization": {
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
},
"userSession": {
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
},
"walledGardens": {
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
},
"macAddressFormat": {
"description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
"type": "integer",
"default": 2,
"minimum": 0,
"maximum": 5
},
"httpsRedirect": {
"description": "HTTPS Redirect is disable or not",
"type": "boolean",
"default": "true"
}
}
}
204
Modify Redirect ¶
PATCH/v6_1/profiles/hotspot/{id}/redirect
Use this API command to modify the redirect information of a Hotspot profile.
Body
{
"url": "https://www.testurl.com"
}
Schema
{
"description": "Redirect configuration of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Portal redirect URL",
"type": "string"
}
}
}
204
Modify Portal Customization ¶
PATCH/v6_1/profiles/hotspot/{id}/portalCustomization
Use this API command to modify portal customization of a Hotspot profile.
Body
{
"language": "en_US",
"title": "Ruckus Wireless - Subscriber Portal",
"logo": "logo",
"termsAndConditionsRequired": false
}
Schema
{
"description": "Portal customization of the guest access profile",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language",
"default": "en_US",
"enum": [
"en_US",
"zh_TW",
"zh_CN",
"nl_NL",
"fr_FR",
"de_DE",
"ja_JP",
"es_ES",
"se_SE",
"ar_SA",
"cz_CZ",
"da_DK",
"tr_TR",
"pt_BR"
]
},
"title": {
"description": "Title",
"type": "string",
"minLength": 0,
"maxLength": 63
},
"logo": {
"description": "logo",
"type": "string"
},
"termsAndConditionsRequired": {
"description": "Terms and conditions is required or not",
"type": "boolean",
"default": "false"
},
"termsAndConditionsText": {
"description": "Terms and conditions text",
"type": "string",
"default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
"minLength": 0,
"maxLength": 3999
}
},
"required": [
"language"
]
}
204
Modify UserSession ¶
PATCH/v6_1/profiles/hotspot/{id}/userSession
Use this API command to modify user session of a Hotspot profile.
Body
{
"timeoutInMin": 1440,
"gracePeriodInMin": 60
}
Schema
{
"description": "User session of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"timeoutInMin": {
"description": "Time out value in minutes",
"type": "integer",
"default": 1440,
"minimum": 2,
"maximum": 14400
},
"gracePeriodInMin": {
"description": "Grace period in minutes",
"type": "integer",
"default": 60,
"minimum": 1,
"maximum": 14399
}
}
}
204
Modify Location ¶
PATCH/v6_1/profiles/hotspot/{id}/location
Use this API command to modify the location information of a Hotspot profile.
Body
{
"id": "locationId",
"name": "locationName"
}
Schema
{
"description": "Location of the Hotspot",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Portal location id",
"type": "string"
},
"name": {
"description": "Portal location name",
"type": "string"
}
}
}
204
Modify Walled Gardens ¶
PATCH/v6_1/profiles/hotspot/{id}/walledGardens
Use this API command to modify a walled gardens of a Hotspot profile.
Body
[
"10.1.1.1",
"11.11.111.11"
]
Schema
{
"description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like - *.amazon.com - *.com",
"type": "array",
"items": {
"type": "string"
}
}
204
Authentication Profile ¶
Retrieve List - authentication profiles by query criteria ¶
POST/v6_1/profiles/auth/query
Use this API command to retrieve a list of authentication profiles by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "5f154cd0-6f91-11e4-9984-068020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"name": "authenticationProfileName",
"description": null,
"gppSuppportEnabled": true,
"aaaSuppportEnabled": true,
"ttgCommonSetting": {
"interimAcctInterval": 600,
"sessionTimeout": 22,
"sessionIdleTimeout": 120,
"mobileCountryCode": "086",
"mobileNetworkCode": "010"
},
"realmMappings": [
{
"realm": "No Match",
"id": null,
"name": null,
"dynamicVlanId": null,
"serviceType": "NA",
"authorizationMethod": "NonGPPCallFlow"
},
{
"realm": "Unspecified",
"id": null,
"name": null,
"dynamicVlanId": null,
"serviceType": "NA",
"authorizationMethod": "NonGPPCallFlow"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for authentication server profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication profile",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"name": {
"description": "Name of the authentication profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the authentication profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"gppSuppportEnabled": {
"description": "3GPP support enabled or disabled",
"type": "boolean"
},
"aaaSuppportEnabled": {
"description": "Hosted AAA support enabled or disabled",
"type": "boolean"
},
"h20SuppportEnabled": {
"description": "Hotspot 2.0 support enabled or disabled",
"type": "boolean"
},
"ttgCommonSetting": {
"description": "Hosted AAA server RADIUS settings & PLMN ID settings",
"type": "object",
"properties": {
"interimAcctInterval": {
"type": "integer",
"description": "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout": {
"type": "integer",
"description": "Session timeout (unit: seconds)",
"minimum": 0,
"maximum": 2147483647,
"default": 0
},
"sessionIdleTimeout": {
"type": "integer",
"description": "Session idle timeout (unit: seconds)",
"minimum": 90,
"maximum": 600,
"default": 120
},
"mobileCountryCode": {
"type": "string",
"description": "Mobile country code",
"minLength": 3,
"maxLength": 3,
"pattern": "[0-9]+"
},
"mobileNetworkCode": {
"type": "string",
"description": "Mobile network code",
"minLength": 2,
"maxLength": 3,
"pattern": "[0-9]+"
}
}
},
"realmMappings": {
"type": "array",
"description": "Realm based authentication service mappings",
"items": {
"type": "object",
"description": "Realm based authentication service mappings",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Authentication service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"LOCAL_DB",
"HLR",
"AD",
"LDAP"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Authentication service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Authentication service name"
},
"authorizationMethod": {
"description": "Authorization method",
"enum": [
"NonGPPCallFlow",
"GPPCallFlow",
"UpdateGPRSLocation",
"RestoreData",
"NoAutz"
]
},
"dynamicVlanId": {
"type": [
"integer",
"null"
],
"description": "Dynamic VLAN ID",
"minimum": 2,
"maximum": 4094
},
"hostedAaaEnabled": {
"type": "boolean"
}
},
"required": [
"realm",
"serviceType",
"authorizationMethod"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve List - authentication service info. ¶
POST/v6_1/profiles/auth/authServiceList/query
Use this API command to retrieve a list of authentication service. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6",
"serviceId": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6",
"serviceName": "RadiusAuthenticationServer1",
"serviceType": ""
}
]
}
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": "ID of service",
"type": "string"
},
"serviceId": {
"description": "ID of service",
"type": "string"
},
"serviceName": {
"description": "Name of service",
"type": "string"
},
"serviceType": {
"description": "Type of service",
"type": "string"
}
}
}
}
}
}
Retrieve List ¶
GET/v6_1/profiles/auth
Use this API command to retrieve a list of authentication profiles.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "5f154cd0-6f91-11e4-9984-068020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"name": "authenticationProfileName",
"description": null,
"gppSuppportEnabled": true,
"aaaSuppportEnabled": true,
"ttgCommonSetting": {
"interimAcctInterval": 600,
"sessionTimeout": 22,
"sessionIdleTimeout": 120,
"mobileCountryCode": "086",
"mobileNetworkCode": "010"
},
"realmMappings": [
{
"realm": "No Match",
"id": null,
"name": null,
"dynamicVlanId": null,
"serviceType": "NA",
"authorizationMethod": "NonGPPCallFlow"
},
{
"realm": "Unspecified",
"id": null,
"name": null,
"dynamicVlanId": null,
"serviceType": "NA",
"authorizationMethod": "NonGPPCallFlow"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for authentication server profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication profile",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"name": {
"description": "Name of the authentication profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the authentication profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"gppSuppportEnabled": {
"description": "3GPP support enabled or disabled",
"type": "boolean"
},
"aaaSuppportEnabled": {
"description": "Hosted AAA support enabled or disabled",
"type": "boolean"
},
"h20SuppportEnabled": {
"description": "Hotspot 2.0 support enabled or disabled",
"type": "boolean"
},
"ttgCommonSetting": {
"description": "Hosted AAA server RADIUS settings & PLMN ID settings",
"type": "object",
"properties": {
"interimAcctInterval": {
"type": "integer",
"description": "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout": {
"type": "integer",
"description": "Session timeout (unit: seconds)",
"minimum": 0,
"maximum": 2147483647,
"default": 0
},
"sessionIdleTimeout": {
"type": "integer",
"description": "Session idle timeout (unit: seconds)",
"minimum": 90,
"maximum": 600,
"default": 120
},
"mobileCountryCode": {
"type": "string",
"description": "Mobile country code",
"minLength": 3,
"maxLength": 3,
"pattern": "[0-9]+"
},
"mobileNetworkCode": {
"type": "string",
"description": "Mobile network code",
"minLength": 2,
"maxLength": 3,
"pattern": "[0-9]+"
}
}
},
"realmMappings": {
"type": "array",
"description": "Realm based authentication service mappings",
"items": {
"type": "object",
"description": "Realm based authentication service mappings",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Authentication service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"LOCAL_DB",
"HLR",
"AD",
"LDAP"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Authentication service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Authentication service name"
},
"authorizationMethod": {
"description": "Authorization method",
"enum": [
"NonGPPCallFlow",
"GPPCallFlow",
"UpdateGPRSLocation",
"RestoreData",
"NoAutz"
]
},
"dynamicVlanId": {
"type": [
"integer",
"null"
],
"description": "Dynamic VLAN ID",
"minimum": 2,
"maximum": 4094
},
"hostedAaaEnabled": {
"type": "boolean"
}
},
"required": [
"realm",
"serviceType",
"authorizationMethod"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/profiles/auth/{id}
Use this API command to retrieve an authentication profile.
200
Body
{
"id": "5f154cd0-6f91-11e4-9984-068020524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"name": "authenticationProfileName",
"description": null,
"gppSuppportEnabled": true,
"aaaSuppportEnabled": true,
"ttgCommonSetting": {
"interimAcctInterval": 600,
"sessionTimeout": 22,
"sessionIdleTimeout": 120,
"mobileCountryCode": "086",
"mobileNetworkCode": "010"
},
"realmMappings": [
{
"realm": "No Match",
"id": null,
"name": null,
"dynamicVlanId": null,
"serviceType": "NA",
"authorizationMethod": "NonGPPCallFlow"
},
{
"realm": "Unspecified",
"id": null,
"name": null,
"dynamicVlanId": null,
"serviceType": "NA",
"authorizationMethod": "NonGPPCallFlow"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the authentication profile",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"name": {
"description": "Name of the authentication profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the authentication profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"gppSuppportEnabled": {
"description": "3GPP support enabled or disabled",
"type": "boolean"
},
"aaaSuppportEnabled": {
"description": "Hosted AAA support enabled or disabled",
"type": "boolean"
},
"h20SuppportEnabled": {
"description": "Hotspot 2.0 support enabled or disabled",
"type": "boolean"
},
"ttgCommonSetting": {
"description": "Hosted AAA server RADIUS settings & PLMN ID settings",
"type": "object",
"properties": {
"interimAcctInterval": {
"type": "integer",
"description": "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout": {
"type": "integer",
"description": "Session timeout (unit: seconds)",
"minimum": 0,
"maximum": 2147483647,
"default": 0
},
"sessionIdleTimeout": {
"type": "integer",
"description": "Session idle timeout (unit: seconds)",
"minimum": 90,
"maximum": 600,
"default": 120
},
"mobileCountryCode": {
"type": "string",
"description": "Mobile country code",
"minLength": 3,
"maxLength": 3,
"pattern": "[0-9]+"
},
"mobileNetworkCode": {
"type": "string",
"description": "Mobile network code",
"minLength": 2,
"maxLength": 3,
"pattern": "[0-9]+"
}
}
},
"realmMappings": {
"type": "array",
"description": "Realm based authentication service mappings",
"items": {
"type": "object",
"description": "Realm based authentication service mappings",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Authentication service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"LOCAL_DB",
"HLR",
"AD",
"LDAP"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Authentication service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Authentication service name"
},
"authorizationMethod": {
"description": "Authorization method",
"enum": [
"NonGPPCallFlow",
"GPPCallFlow",
"UpdateGPRSLocation",
"RestoreData",
"NoAutz"
]
},
"dynamicVlanId": {
"type": [
"integer",
"null"
],
"description": "Dynamic VLAN ID",
"minimum": 2,
"maximum": 4094
},
"hostedAaaEnabled": {
"type": "boolean"
}
},
"required": [
"realm",
"serviceType",
"authorizationMethod"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create ¶
POST/v6_1/profiles/auth
Use this API command to create a new authentication profile.
Body
{
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"name": "authenticationProfileName",
"gppSuppportEnabled": false,
"aaaSuppportEnabled": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"name": {
"description": "Name of the authentication profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the authentication profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"gppSuppportEnabled": {
"description": "3GPP support enabled or disabled",
"type": "boolean",
"default": false
},
"aaaSuppportEnabled": {
"description": "Hosted AAA support enabled or disabled",
"type": "boolean",
"default": false
},
"h20SuppportEnabled": {
"description": "Hotspot 2.0 support enabled or disabled",
"type": "boolean"
},
"ttgCommonSetting": {
"description": "Hosted AAA server RADIUS settings & PLMN ID settings",
"type": "object",
"properties": {
"interimAcctInterval": {
"type": "integer",
"description": "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout": {
"type": "integer",
"description": "Session timeout (unit: seconds)",
"minimum": 0,
"maximum": 2147483647,
"default": 0
},
"sessionIdleTimeout": {
"type": "integer",
"description": "Session idle timeout (unit: seconds)",
"minimum": 90,
"maximum": 600,
"default": 120
},
"mobileCountryCode": {
"type": "string",
"description": "Mobile country code",
"minLength": 3,
"maxLength": 3,
"pattern": "[0-9]+"
},
"mobileNetworkCode": {
"type": "string",
"description": "Mobile network code",
"minLength": 2,
"maxLength": 3,
"pattern": "[0-9]+"
}
}
},
"realmMappings": {
"type": "array",
"description": "Realm based authentication service mappings",
"items": {
"type": "object",
"description": "Realm based authentication service mappings",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Authentication service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"LOCAL_DB",
"HLR",
"AD",
"LDAP"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Authentication service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Authentication service name"
},
"authorizationMethod": {
"description": "Authorization method",
"enum": [
"NonGPPCallFlow",
"GPPCallFlow",
"UpdateGPRSLocation",
"RestoreData",
"NoAutz"
]
},
"dynamicVlanId": {
"type": [
"integer",
"null"
],
"description": "Dynamic VLAN ID",
"minimum": 2,
"maximum": 4094
},
"hostedAaaEnabled": {
"type": "boolean"
}
},
"required": [
"realm",
"serviceType",
"authorizationMethod"
]
}
}
},
"required": [
"name",
"gppSuppportEnabled",
"aaaSuppportEnabled"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/auth/{id}
Use this API command to modify the basic information of an authentication profile.
Body
{
"name": "new Name",
"description": "new description",
"ttgCommonSetting": {
"interimAcctInterval": 600,
"sessionTimeout": 0,
"sessionIdleTimeout": 120,
"mobileCountryCode": "086",
"mobileNetworkCode": "010"
},
"realmMappings": [
{
"realm": "No Match",
"serviceType": "LOCAL_DB",
"authorizationMethod": "NonGPPCallFlow"
},
{
"realm": "Unspecified",
"id": "00f6f020-7470-11e4-afe9-08002716c79f",
"name": "auth service",
"serviceType": "RADIUS",
"authorizationMethod": "GPPCallFlow"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"name": {
"description": "Name of the authentication profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the authentication profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"ttgCommonSetting": {
"description": "Hosted AAA server RADIUS settings & PLMN ID settings",
"type": "object",
"properties": {
"interimAcctInterval": {
"type": "integer",
"description": "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout": {
"type": "integer",
"description": "Session timeout (unit: seconds)",
"minimum": 0,
"maximum": 2147483647,
"default": 0
},
"sessionIdleTimeout": {
"type": "integer",
"description": "Session idle timeout (unit: seconds)",
"minimum": 90,
"maximum": 600,
"default": 120
},
"mobileCountryCode": {
"type": "string",
"description": "Mobile country code",
"minLength": 3,
"maxLength": 3,
"pattern": "[0-9]+"
},
"mobileNetworkCode": {
"type": "string",
"description": "Mobile network code",
"minLength": 2,
"maxLength": 3,
"pattern": "[0-9]+"
}
}
},
"realmMappings": {
"type": "array",
"description": "Realm based authentication service mappings",
"items": {
"type": "object",
"description": "Realm based authentication service mappings",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Authentication service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"LOCAL_DB",
"HLR",
"AD",
"LDAP"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Authentication service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Authentication service name"
},
"authorizationMethod": {
"description": "Authorization method",
"enum": [
"NonGPPCallFlow",
"GPPCallFlow",
"UpdateGPRSLocation",
"RestoreData",
"NoAutz"
]
},
"dynamicVlanId": {
"type": [
"integer",
"null"
],
"description": "Dynamic VLAN ID",
"minimum": 2,
"maximum": 4094
},
"hostedAaaEnabled": {
"type": "boolean"
}
},
"required": [
"realm",
"serviceType",
"authorizationMethod"
]
}
},
"gppSuppportEnabled": {
"description": "3GPP support enabled or disabled",
"type": "boolean",
"default": false
},
"aaaSuppportEnabled": {
"description": "Hosted AAA support enabled or disabled",
"type": "boolean",
"default": false
},
"h20SuppportEnabled": {
"description": "Hotspot 2.0 support enabled or disabled",
"type": "boolean"
},
"id": {
"description": "ID of Accounting Profile",
"type": "string"
}
}
}
204
Modify 3GPP Common Settings ¶
PATCH/v6_1/profiles/auth/{id}/ttgCommonSetting
Use this API command to modify 3GPP common settings of an authentication profile.
Body
{
"interimAcctInterval": 600,
"sessionTimeout": 0,
"sessionIdleTimeout": 120,
"mobileCountryCode": "086",
"mobileNetworkCode": "010"
}
Schema
{
"description": "Hosted AAA server RADIUS settings & PLMN ID settings",
"type": "object",
"properties": {
"interimAcctInterval": {
"type": "integer",
"description": "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout": {
"type": "integer",
"description": "Session timeout (unit: seconds)",
"minimum": 0,
"maximum": 2147483647,
"default": 0
},
"sessionIdleTimeout": {
"type": "integer",
"description": "Session idle timeout (unit: seconds)",
"minimum": 90,
"maximum": 600,
"default": 120
},
"mobileCountryCode": {
"type": "string",
"description": "Mobile country code",
"minLength": 3,
"maxLength": 3,
"pattern": "[0-9]+"
},
"mobileNetworkCode": {
"type": "string",
"description": "Mobile network code",
"minLength": 2,
"maxLength": 3,
"pattern": "[0-9]+"
}
}
}
204
Modify Realm Mappings ¶
PATCH/v6_1/profiles/auth/{id}/realmMappings
Use this API command to modify realm based authentication service mappings of an authentication profile.
Body
[
{
"realm": "No Match",
"serviceType": "LOCAL_DB",
"authorizationMethod": "NonGPPCallFlow"
},
{
"realm": "Unspecified",
"id": "00f6f020-7470-11e4-afe9-08002716c79f",
"name": "auth service",
"serviceType": "RADIUS",
"authorizationMethod": "GPPCallFlow"
}
]
Schema
{
"type": "array",
"description": "Realm based authentication service mappings",
"items": {
"type": "object",
"description": "Realm based authentication service mappings",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Authentication service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"LOCAL_DB",
"HLR",
"AD",
"LDAP"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Authentication service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Authentication service name"
},
"authorizationMethod": {
"description": "Authorization method",
"enum": [
"NonGPPCallFlow",
"GPPCallFlow",
"UpdateGPRSLocation",
"RestoreData",
"NoAutz"
]
},
"dynamicVlanId": {
"type": [
"integer",
"null"
],
"description": "Dynamic VLAN ID",
"minimum": 2,
"maximum": 4094
},
"hostedAaaEnabled": {
"type": "boolean"
}
},
"required": [
"realm",
"serviceType",
"authorizationMethod"
]
}
}
204
Delete ¶
DELETE/v6_1/profiles/auth/{id}
Use this API command to delete an authentication profile.
204
Delete ¶
DELETE/v6_1/profiles/auth
Use this API command to delete a list of authentication profile.
Body
{
"idList": [
"839f87c6-d116-497e-afce-aa8157abdasd"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Clone ¶
POST/v6_1/profiles/auth/clone/{id}
Use this API command to clone an authentication profile.
Body
{
"oldId": "839f87c6-d116-497e-afce-aa8157abdasd",
"newName": "new name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"oldName": {
"description": "original name",
"type": "string"
},
"oldId": {
"description": "original name",
"type": "string"
},
"newName": {
"description": "Id for new profile",
"type": "string"
},
"newId": {
"description": "name for new profile",
"type": "string"
}
}
}
200
Body
{
"oldId": "839f87c6-d116-497e-afce-aa8157abdasd",
"newId": "fe171501-ad2c-11e5-b656-5254003f0277",
"oldName": "old name",
"newName": "new name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"oldName": {
"description": "original name",
"type": "string"
},
"oldId": {
"description": "original name",
"type": "string"
},
"newName": {
"description": "Id for new profile",
"type": "string"
},
"newId": {
"description": "name for new profile",
"type": "string"
}
}
}
Accounting Profile ¶
Retrieve List - accounting profiles by query criteria ¶
POST/v6_1/profiles/acct/query
Use this API command to retrieve a list of accounting profiles by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"name": "new name",
"description": "new description",
"realmMappings": [
{
"realm": "realm",
"id": "78585bb0-7126-11e4-a730-0800276fe6ca",
"name": "acct service",
"serviceType": "RADIUS"
},
{
"realm": "No Match",
"id": "78585bb0-7126-11e4-a730-0800276fe6ca",
"name": "acct service",
"serviceType": "RADIUS"
},
{
"realm": "Unspecified",
"id": null,
"name": null,
"serviceType": "NA"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for accounting server profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the accounting profile",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"name": {
"description": "Name of the accounting profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the accounting profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"realmMappings": {
"type": "array",
"description": "Accounting service per realm",
"items": {
"type": "object",
"description": "Accounting service per realm",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Accounting service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"CGF"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Accounting service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Accounting service name"
}
},
"required": [
"realm",
"serviceType"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve List ¶
GET/v6_1/profiles/acct
Use this API command to retrieve a list of accounting profiles.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"name": "new name",
"description": "new description",
"realmMappings": [
{
"realm": "realm",
"id": "78585bb0-7126-11e4-a730-0800276fe6ca",
"name": "acct service",
"serviceType": "RADIUS"
},
{
"realm": "No Match",
"id": "78585bb0-7126-11e4-a730-0800276fe6ca",
"name": "acct service",
"serviceType": "RADIUS"
},
{
"realm": "Unspecified",
"id": null,
"name": null,
"serviceType": "NA"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for accounting server profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the accounting profile",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"name": {
"description": "Name of the accounting profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the accounting profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"realmMappings": {
"type": "array",
"description": "Accounting service per realm",
"items": {
"type": "object",
"description": "Accounting service per realm",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Accounting service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"CGF"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Accounting service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Accounting service name"
}
},
"required": [
"realm",
"serviceType"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/profiles/acct/{id}
Use this API command to retrieve an accounting profile.
200
Body
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"name": "new name",
"description": "new description",
"realmMappings": [
{
"realm": "realm",
"id": "78585bb0-7126-11e4-a730-0800276fe6ca",
"name": "acct service",
"serviceType": "RADIUS"
},
{
"realm": "No Match",
"id": "78585bb0-7126-11e4-a730-0800276fe6ca",
"name": "acct service",
"serviceType": "RADIUS"
},
{
"realm": "Unspecified",
"id": null,
"name": null,
"serviceType": "NA"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the accounting profile",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"name": {
"description": "Name of the accounting profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the accounting profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"realmMappings": {
"type": "array",
"description": "Accounting service per realm",
"items": {
"type": "object",
"description": "Accounting service per realm",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Accounting service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"CGF"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Accounting service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Accounting service name"
}
},
"required": [
"realm",
"serviceType"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create ¶
POST/v6_1/profiles/acct
Use this API command to create a new accounting profile.
Body
{
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"name": "accountingProfileName"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the accounting profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the accounting profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"realmMappings": {
"type": "array",
"description": "Accounting service per realm",
"items": {
"type": "object",
"description": "Accounting service per realm",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Accounting service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"CGF"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Accounting service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Accounting service name"
}
},
"required": [
"realm",
"serviceType"
]
}
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
}
},
"required": [
"name"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/acct/{id}
Use this API command to modify the basic information of an accounting profile.
Body
{
"name": "new name",
"description": "new description",
"realmMappings": [
{
"realm": "realm",
"id": "78585bb0-7126-11e4-a730-0800276fe6ca",
"serviceType": "RADIUS"
},
{
"realm": "No Match",
"name": "acct service",
"serviceType": "RADIUS"
},
{
"realm": "Unspecified",
"id": null,
"name": null,
"serviceType": "NA"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the accounting profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the accounting profile",
"type": [
"string",
"null"
],
"maxLength": 128,
"pattern": "^$|^([!-~]([ -~]){0,126}[!-~]|[!-~]{1,1})$"
},
"realmMappings": {
"type": "array",
"description": "Accounting service per realm",
"items": {
"type": "object",
"description": "Accounting service per realm",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Accounting service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"CGF"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Accounting service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Accounting service name"
}
},
"required": [
"realm",
"serviceType"
]
}
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"id": {
"description": "ID of Accounting Profile",
"type": "string"
}
}
}
204
Modify Realm Mappings ¶
PATCH/v6_1/profiles/acct/{id}/realmMappings
Use this API command to modify accounting service per realm mappings of an accounting profile.
Body
[
{
"realm": "realm",
"id": "78585bb0-7126-11e4-a730-0800276fe6ca",
"serviceType": "RADIUS"
},
{
"realm": "No Match",
"name": "acct service",
"serviceType": "RADIUS"
},
{
"realm": "Unspecified",
"id": null,
"name": null,
"serviceType": "NA"
}
]
Schema
{
"type": "array",
"description": "Accounting service per realm",
"items": {
"type": "object",
"description": "Accounting service per realm",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Accounting service type, NA is NA-Request Rejected",
"enum": [
"NA",
"RADIUS",
"CGF"
]
},
"id": {
"type": [
"string",
"null"
],
"description": "Accounting service UUID"
},
"name": {
"type": [
"string",
"null"
],
"description": "Accounting service name"
}
},
"required": [
"realm",
"serviceType"
]
}
}
204
Delete ¶
Delete ¶
DELETE/v6_1/profiles/acct
Use this API command to delete a list of accounting profile.
Body
{
"idList": [
"839f87c6-d116-497e-afce-aa8157abdasd"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Clone ¶
POST/v6_1/profiles/acct/clone/{id}
Use this API command to clone an accounting profile.
Body
{
"oldId": "839f87c6-d116-497e-afce-aa8157abdasd",
"newName": "new name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"oldName": {
"description": "original name",
"type": "string"
},
"oldId": {
"description": "original name",
"type": "string"
},
"newName": {
"description": "Id for new profile",
"type": "string"
},
"newId": {
"description": "name for new profile",
"type": "string"
}
}
}
200
Body
{
"oldId": "839f87c6-d116-497e-afce-aa8157abdasd",
"newId": "fe171501-ad2c-11e5-b656-5254003f0277",
"oldName": "old name",
"newName": "new name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"oldName": {
"description": "original name",
"type": "string"
},
"oldId": {
"description": "original name",
"type": "string"
},
"newName": {
"description": "Id for new profile",
"type": "string"
},
"newId": {
"description": "name for new profile",
"type": "string"
}
}
}
IPSEC Profile ¶
Retrieve List ¶
GET/v6_1/profiles/tunnel/ipsec
Retrieve a list of IPSEC.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"name": "new name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/profiles/tunnel/ipsec/{id}
Retrieve a IPSEC.
200
Body
{
"id": "0b767870-ab59-11e4-87f2-000c29c1611c",
"name": "ipsec content",
"description": "ipsec content description",
"serverAddr": "221.11.11.11",
"authType": "PresharedKey",
"preSharedKey": "2212222111",
"ikeSecurityAssociation": {
"ikeProposalType": "Specific",
"ikeProposals": [
{
"encAlg": "AES128",
"authAlg": "SHA1",
"prfAlg": "UseIntegrityALG",
"dhGroup": "Modp2048"
},
{
"encAlg": "ThreeDES",
"authAlg": "MD5",
"prfAlg": "UseIntegrityALG",
"dhGroup": "Modp8192"
}
]
},
"espSecurityAssociation": {
"espProposalType": "Specific",
"espProposals": [
{
"encAlg": "AES128",
"authAlg": "SHA1",
"dhGroup": "Modp2048"
},
{
"encAlg": "ThreeDES",
"authAlg": "MD5",
"dhGroup": "Modp8192"
}
]
},
"ikeRekeyTime": 0,
"ikeRekeyTimeUnit": "hour",
"espRekeyTime": 0,
"espRekeyTimeUnit": "day",
"cmProtocolOption": {
"cmpDhcpOpt43Subcode": 55,
"cmpServerAddr": "cmp test addr",
"cmpServerPath": "cmp test path"
},
"advancedOption": {
"dhcpOpt43Subcode": 8,
"retryLimit": 6,
"replayWindow": 30,
"ipcompEnable": "Enabled",
"enforceNatt": "Enabled",
"dpdDelay": 11,
"keepAliveIntval": 2,
"failoverRetryPeriod": 5,
"failoverRetryInterval": 6,
"failoverMode": "Revertive",
"failoverPrimaryCheckInterval": 7
},
"ipMode": "IPV4"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of the ipsec profile",
"type": "string"
},
"name": {
"description": "name of the ipsec profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the ipsec profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"serverAddr": {
"description": "server Addr of the ipsec profile",
"type": "string"
},
"authType": {
"description": "authentication type of the ipsec profile",
"enum": [
"PresharedKey",
"Certificate"
]
},
"preSharedKey": {
"description": "authentication preShared Key of the ipsec profile",
"type": "string"
},
"ikeSecurityAssociation": {
"description": "ikeProposal Security Association Content",
"type": "object",
"properties": {
"ikeProposalType": {
"description": "ikeProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"ikeProposals": {
"type": "array",
"description": "ikeProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "IkeProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of ikeProposal Specific",
"enum": [
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of ikeProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"prfAlg": {
"description": "prfAlg of ikeProposal Specific",
"enum": [
"UseIntegrityALG",
"PRF_MD5",
"PRF_SHA1",
"PRF_AES_CBC",
"PRF_AES_MAC",
"PRF_SHA256",
"PRF_SHA384",
"PRF_SHA512"
]
},
"dhGroup": {
"description": "dhGroup of ikeProposal Specific",
"enum": [
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"prfAlg",
"dhGroup"
]
}
}
}
},
"espSecurityAssociation": {
"description": "espProposal Security Association Content",
"type": "object",
"properties": {
"espProposalType": {
"description": "espProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"espProposals": {
"type": "array",
"description": "espProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "EspProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of espProposal Specific",
"enum": [
"None",
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of espProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"dhGroup": {
"description": "dhGroup of espProposal Specific",
"enum": [
"None",
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"dhGroup"
]
}
}
}
},
"ikeRekeyTime": {
"description": "ikeRekey Time of the ipsec profile",
"type": "number"
},
"ikeRekeyTimeUnit": {
"description": "time unit",
"enum": [
"second",
"minute",
"hour",
"day"
]
},
"espRekeyTime": {
"description": "espRekey Time of the ipsec profile",
"type": "number"
},
"espRekeyTimeUnit": {
"description": "time unit",
"enum": [
"second",
"minute",
"hour",
"day"
]
},
"cmProtocolOption": {
"description": "Certificate Management Protocol Option",
"type": "object",
"properties": {
"cmpDhcpOpt43Subcode": {
"description": "Certificate Management Protocol dhcpOpt43Subcode",
"type": "number"
},
"cmpServerAddr": {
"description": "Certificate Management Protocol Server addr",
"type": "string"
},
"cmpServerPath": {
"description": "Certificate Management Protocol Server Path",
"type": "string"
},
"cmpDhcpOpt43SubcodeRecipient": {
"description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
"type": "number"
},
"cmpRecipient": {
"description": "Certificate Management Protocol Recipient",
"type": "string"
}
},
"required": [
"cmpDhcpOpt43Subcode"
]
},
"advancedOption": {
"description": "advanced option Content",
"type": "object",
"properties": {
"dhcpOpt43Subcode": {
"description": "dhcpOpt43Subcode of the ipsec profile",
"type": "number"
},
"retryLimit": {
"description": "retryLimit of the ipsec profile",
"type": "number"
},
"replayWindow": {
"description": "replayWindow of the ipsec profile",
"type": "number"
},
"ipcompEnable": {
"description": "ipcomp Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"enforceNatt": {
"description": "enforceNatt Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"dpdDelay": {
"description": "dpdDelay of the ipsec profile",
"type": "number"
},
"keepAliveIntval": {
"description": "keepAliveIntval of the ipsec profile",
"type": "number"
},
"failoverRetryPeriod": {
"description": "Retry Period of the failover",
"type": "number"
},
"failoverRetryInterval": {
"description": "Retry Interval of the failover",
"type": "number"
},
"failoverMode": {
"description": "mode of the failover",
"enum": [
"Non_Revertive",
"Revertive"
]
},
"failoverPrimaryCheckInterval": {
"description": "Primary Check Interval of the failover",
"type": "number"
}
}
},
"ipMode": {
"description": "ipMode of the ipsec profile",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"domainId": {
"description": "Domain id of the IPSec profile",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create ipsec ¶
POST/v6_1/profiles/tunnel/ipsec
Create a new ipsec.
Body
{
"name": "ipsec create",
"description": "ipsec create description",
"serverAddr": "111.11.11.11",
"authType": "PresharedKey",
"preSharedKey": "11111111111",
"ikeRekeyTime": 4,
"espRekeyTime": 1,
"ikeRekeyTimeUnit": "minute",
"espRekeyTimeUnit": "day",
"ipMode": "IPV4"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of the ipsec profile",
"type": "string"
},
"name": {
"description": "name of the ipsec profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the ipsec profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"serverAddr": {
"description": "server Addr of the ipsec profile",
"type": "string"
},
"authType": {
"description": "authentication type of the ipsec profile",
"enum": [
"PresharedKey",
"Certificate"
]
},
"preSharedKey": {
"description": "authentication preShared Key of the ipsec profile",
"type": "string"
},
"ikeSecurityAssociation": {
"description": "ikeProposal Security Association Content",
"type": "object",
"properties": {
"ikeProposalType": {
"description": "ikeProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"ikeProposals": {
"type": "array",
"description": "ikeProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "IkeProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of ikeProposal Specific",
"enum": [
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of ikeProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"prfAlg": {
"description": "prfAlg of ikeProposal Specific",
"enum": [
"UseIntegrityALG",
"PRF_MD5",
"PRF_SHA1",
"PRF_AES_CBC",
"PRF_AES_MAC",
"PRF_SHA256",
"PRF_SHA384",
"PRF_SHA512"
]
},
"dhGroup": {
"description": "dhGroup of ikeProposal Specific",
"enum": [
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"prfAlg",
"dhGroup"
]
}
}
}
},
"espSecurityAssociation": {
"description": "espProposal Security Association Content",
"type": "object",
"properties": {
"espProposalType": {
"description": "espProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"espProposals": {
"type": "array",
"description": "espProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "EspProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of espProposal Specific",
"enum": [
"None",
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of espProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"dhGroup": {
"description": "dhGroup of espProposal Specific",
"enum": [
"None",
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"dhGroup"
]
}
}
}
},
"ikeRekeyTime": {
"description": "ikeRekey Time of the ipsec profile",
"type": "number"
},
"ikeRekeyTimeUnit": {
"description": "time unit",
"enum": [
"second",
"minute",
"hour",
"day"
]
},
"espRekeyTime": {
"description": "espRekey Time of the ipsec profile",
"type": "number"
},
"espRekeyTimeUnit": {
"description": "time unit",
"enum": [
"second",
"minute",
"hour",
"day"
]
},
"cmProtocolOption": {
"description": "Certificate Management Protocol Option",
"type": "object",
"properties": {
"cmpDhcpOpt43Subcode": {
"description": "Certificate Management Protocol dhcpOpt43Subcode",
"type": "number"
},
"cmpServerAddr": {
"description": "Certificate Management Protocol Server addr",
"type": "string"
},
"cmpServerPath": {
"description": "Certificate Management Protocol Server Path",
"type": "string"
},
"cmpDhcpOpt43SubcodeRecipient": {
"description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
"type": "number"
},
"cmpRecipient": {
"description": "Certificate Management Protocol Recipient",
"type": "string"
}
},
"required": [
"cmpDhcpOpt43Subcode"
]
},
"advancedOption": {
"description": "advanced option Content",
"type": "object",
"properties": {
"dhcpOpt43Subcode": {
"description": "dhcpOpt43Subcode of the ipsec profile",
"type": "number"
},
"retryLimit": {
"description": "retryLimit of the ipsec profile",
"type": "number"
},
"replayWindow": {
"description": "replayWindow of the ipsec profile",
"type": "number"
},
"ipcompEnable": {
"description": "ipcomp Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"enforceNatt": {
"description": "enforceNatt Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"dpdDelay": {
"description": "dpdDelay of the ipsec profile",
"type": "number"
},
"keepAliveIntval": {
"description": "keepAliveIntval of the ipsec profile",
"type": "number"
},
"failoverRetryPeriod": {
"description": "Retry Period of the failover",
"type": "number"
},
"failoverRetryInterval": {
"description": "Retry Interval of the failover",
"type": "number"
},
"failoverMode": {
"description": "mode of the failover",
"enum": [
"Non_Revertive",
"Revertive"
]
},
"failoverPrimaryCheckInterval": {
"description": "Primary Check Interval of the failover",
"type": "number"
}
}
},
"ipMode": {
"description": "ipMode of the ipsec profile",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"domainId": {
"description": "Domain id of the IPSec profile",
"type": "string"
}
},
"required": [
"name",
"serverAddr",
"ikeRekeyTime",
"espRekeyTime",
"ipMode"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/tunnel/ipsec/{id}
Modify a specific ipsec basic.
Body
{
"name": "ipsec moify",
"description": "ipsec modify description",
"serverAddr": "221.11.11.11",
"authType": "PresharedKey",
"preSharedKey": "2212222111",
"ikeRekeyTime": 5,
"espRekeyTime": 6,
"ikeRekeyTimeUnit": "hour",
"espRekeyTimeUnit": "day",
"ikeProposalType": "Specific",
"ikeSecurityAssociation": {
"ikeProposalType": "Specific",
"ikeProposals": [
{
"encAlg": "AES128",
"authAlg": "SHA1",
"prfAlg": "UseIntegrityALG",
"dhGroup": "Modp2048"
},
{
"encAlg": "ThreeDES",
"authAlg": "MD5",
"prfAlg": "UseIntegrityALG",
"dhGroup": "Modp8192"
}
]
},
"espSecurityAssociation": {
"espProposalType": "Specific",
"espProposals": [
{
"encAlg": "AES128",
"authAlg": "SHA1",
"dhGroup": "Modp2048"
},
{
"encAlg": "ThreeDES",
"authAlg": "MD5",
"dhGroup": "Modp8192"
}
]
},
"cmProtocolOption": {
"cmpDhcpOpt43Subcode": 55,
"cmpServerAddr": "cmp test addr",
"cmpServerPath": "cmp test path"
},
"advancedOption": {
"dhcpOpt43Subcode": 8,
"retryLimit": 6,
"replayWindow": 30,
"ipcompEnable": "Enabled",
"enforceNatt": "Enabled",
"dpdDelay": 11,
"keepAliveIntval": 2,
"failoverRetryPeriod": 5,
"failoverRetryInterval": 6,
"failoverMode": "Revertive",
"failoverPrimaryCheckInterval": 7
},
"ipMode": "IPV6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of the ipsec profile",
"type": "string"
},
"name": {
"description": "name of the ipsec profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the ipsec profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"serverAddr": {
"description": "server Addr of the ipsec profile",
"type": "string"
},
"authType": {
"description": "authentication type of the ipsec profile",
"enum": [
"PresharedKey",
"Certificate"
]
},
"preSharedKey": {
"description": "authentication preShared Key of the ipsec profile",
"type": "string"
},
"ikeSecurityAssociation": {
"description": "ikeProposal Security Association Content",
"type": "object",
"properties": {
"ikeProposalType": {
"description": "ikeProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"ikeProposals": {
"type": "array",
"description": "ikeProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "IkeProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of ikeProposal Specific",
"enum": [
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of ikeProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"prfAlg": {
"description": "prfAlg of ikeProposal Specific",
"enum": [
"UseIntegrityALG",
"PRF_MD5",
"PRF_SHA1",
"PRF_AES_CBC",
"PRF_AES_MAC",
"PRF_SHA256",
"PRF_SHA384",
"PRF_SHA512"
]
},
"dhGroup": {
"description": "dhGroup of ikeProposal Specific",
"enum": [
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"prfAlg",
"dhGroup"
]
}
}
}
},
"espSecurityAssociation": {
"description": "espProposal Security Association Content",
"type": "object",
"properties": {
"espProposalType": {
"description": "espProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"espProposals": {
"type": "array",
"description": "espProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "EspProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of espProposal Specific",
"enum": [
"None",
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of espProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"dhGroup": {
"description": "dhGroup of espProposal Specific",
"enum": [
"None",
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"dhGroup"
]
}
}
}
},
"ikeRekeyTime": {
"description": "ikeRekey Time of the ipsec profile",
"type": "number"
},
"ikeRekeyTimeUnit": {
"description": "time unit",
"enum": [
"second",
"minute",
"hour",
"day"
]
},
"espRekeyTime": {
"description": "espRekey Time of the ipsec profile",
"type": "number"
},
"espRekeyTimeUnit": {
"description": "time unit",
"enum": [
"second",
"minute",
"hour",
"day"
]
},
"cmProtocolOption": {
"description": "Certificate Management Protocol Option",
"type": "object",
"properties": {
"cmpDhcpOpt43Subcode": {
"description": "Certificate Management Protocol dhcpOpt43Subcode",
"type": "number"
},
"cmpServerAddr": {
"description": "Certificate Management Protocol Server addr",
"type": "string"
},
"cmpServerPath": {
"description": "Certificate Management Protocol Server Path",
"type": "string"
},
"cmpDhcpOpt43SubcodeRecipient": {
"description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
"type": "number"
},
"cmpRecipient": {
"description": "Certificate Management Protocol Recipient",
"type": "string"
}
},
"required": [
"cmpDhcpOpt43Subcode"
]
},
"advancedOption": {
"description": "advanced option Content",
"type": "object",
"properties": {
"dhcpOpt43Subcode": {
"description": "dhcpOpt43Subcode of the ipsec profile",
"type": "number"
},
"retryLimit": {
"description": "retryLimit of the ipsec profile",
"type": "number"
},
"replayWindow": {
"description": "replayWindow of the ipsec profile",
"type": "number"
},
"ipcompEnable": {
"description": "ipcomp Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"enforceNatt": {
"description": "enforceNatt Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"dpdDelay": {
"description": "dpdDelay of the ipsec profile",
"type": "number"
},
"keepAliveIntval": {
"description": "keepAliveIntval of the ipsec profile",
"type": "number"
},
"failoverRetryPeriod": {
"description": "Retry Period of the failover",
"type": "number"
},
"failoverRetryInterval": {
"description": "Retry Interval of the failover",
"type": "number"
},
"failoverMode": {
"description": "mode of the failover",
"enum": [
"Non_Revertive",
"Revertive"
]
},
"failoverPrimaryCheckInterval": {
"description": "Primary Check Interval of the failover",
"type": "number"
}
}
},
"ipMode": {
"description": "ipMode of the ipsec profile",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"domainId": {
"description": "Domain id of the IPSec profile",
"type": "string"
}
}
}
204
Modify ikeSecurityAssociation ¶
PATCH/v6_1/profiles/tunnel/ipsec/{id}/ikeSecurityAssociation
Modify a specific ipsec ikeSecurityAssociation.
Body
{
"ikeProposalType": "Specific",
"ikeProposals": [
{
"encAlg": "AES128",
"authAlg": "SHA1",
"prfAlg": "UseIntegrityALG",
"dhGroup": "Modp2048"
},
{
"encAlg": "ThreeDES",
"authAlg": "MD5",
"prfAlg": "UseIntegrityALG",
"dhGroup": "Modp8192"
}
]
}
Schema
{
"description": "ikeProposal Security Association Content",
"type": "object",
"properties": {
"ikeProposalType": {
"description": "ikeProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"ikeProposals": {
"type": "array",
"description": "ikeProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "IkeProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of ikeProposal Specific",
"enum": [
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of ikeProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"prfAlg": {
"description": "prfAlg of ikeProposal Specific",
"enum": [
"UseIntegrityALG",
"PRF_MD5",
"PRF_SHA1",
"PRF_AES_CBC",
"PRF_AES_MAC",
"PRF_SHA256",
"PRF_SHA384",
"PRF_SHA512"
]
},
"dhGroup": {
"description": "dhGroup of ikeProposal Specific",
"enum": [
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"prfAlg",
"dhGroup"
]
}
}
}
}
204
Modify espSecurityAssociation ¶
PATCH/v6_1/profiles/tunnel/ipsec/{id}/espSecurityAssociation
Modify a specific ipsec espSecurityAssociation.
Body
{
"espProposalType": "Specific",
"espProposals": [
{
"encAlg": "AES128",
"authAlg": "SHA1",
"dhGroup": "Modp2048"
},
{
"encAlg": "ThreeDES",
"authAlg": "MD5",
"dhGroup": "Modp8192"
}
]
}
Schema
{
"description": "espProposal Security Association Content",
"type": "object",
"properties": {
"espProposalType": {
"description": "espProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"espProposals": {
"type": "array",
"description": "espProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "EspProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of espProposal Specific",
"enum": [
"None",
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of espProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"dhGroup": {
"description": "dhGroup of espProposal Specific",
"enum": [
"None",
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"dhGroup"
]
}
}
}
}
204
Modify cmProtocolOption ¶
PATCH/v6_1/profiles/tunnel/ipsec/{id}/cmProtocolOption
Modify a specific ipsec cmProtocolOption.
Body
{
"cmpDhcpOpt43Subcode": 55,
"cmpServerAddr": "cmp test addr",
"cmpServerPath": "cmp test path"
}
Schema
{
"description": "Certificate Management Protocol Option",
"type": "object",
"properties": {
"cmpDhcpOpt43Subcode": {
"description": "Certificate Management Protocol dhcpOpt43Subcode",
"type": "number"
},
"cmpServerAddr": {
"description": "Certificate Management Protocol Server addr",
"type": "string"
},
"cmpServerPath": {
"description": "Certificate Management Protocol Server Path",
"type": "string"
},
"cmpDhcpOpt43SubcodeRecipient": {
"description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
"type": "number"
},
"cmpRecipient": {
"description": "Certificate Management Protocol Recipient",
"type": "string"
}
},
"required": [
"cmpDhcpOpt43Subcode"
]
}
204
Modify advancedOption ¶
PATCH/v6_1/profiles/tunnel/ipsec/{id}/advancedOption
Modify a specific ipsec advancedOption.
Body
{
"dhcpOpt43Subcode": 8,
"retryLimit": 6,
"replayWindow": 30,
"ipcompEnable": "Enabled",
"enforceNatt": "Enabled",
"dpdDelay": 11,
"keepAliveIntval": 2,
"failoverRetryPeriod": 5,
"failoverRetryInterval": 6,
"failoverMode": "Revertive",
"failoverPrimaryCheckInterval": 7
}
Schema
{
"description": "advanced option Content",
"type": "object",
"properties": {
"dhcpOpt43Subcode": {
"description": "dhcpOpt43Subcode of the ipsec profile",
"type": "number"
},
"retryLimit": {
"description": "retryLimit of the ipsec profile",
"type": "number"
},
"replayWindow": {
"description": "replayWindow of the ipsec profile",
"type": "number"
},
"ipcompEnable": {
"description": "ipcomp Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"enforceNatt": {
"description": "enforceNatt Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"dpdDelay": {
"description": "dpdDelay of the ipsec profile",
"type": "number"
},
"keepAliveIntval": {
"description": "keepAliveIntval of the ipsec profile",
"type": "number"
},
"failoverRetryPeriod": {
"description": "Retry Period of the failover",
"type": "number"
},
"failoverRetryInterval": {
"description": "Retry Interval of the failover",
"type": "number"
},
"failoverMode": {
"description": "mode of the failover",
"enum": [
"Non_Revertive",
"Revertive"
]
},
"failoverPrimaryCheckInterval": {
"description": "Primary Check Interval of the failover",
"type": "number"
}
}
}
204
Delete ¶
DELETE/v6_1/profiles/tunnel/ipsec
Delete multiple ipsec.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Query List ¶
POST/v6_1/profiles/tunnel/ipsec/query
Query a list of IPSEC. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "0b767870-ab59-11e4-87f2-000c29c1611c",
"name": "ipsec content",
"description": "ipsec content description",
"serverAddr": "221.11.11.11",
"authType": "PresharedKey",
"preSharedKey": "2212222111",
"ikeSecurityAssociation": {
"ikeProposalType": "Specific",
"ikeProposals": [
{
"encAlg": "AES128",
"authAlg": "SHA1",
"prfAlg": "UseIntegrityALG",
"dhGroup": "Modp2048"
},
{
"encAlg": "ThreeDES",
"authAlg": "MD5",
"prfAlg": "UseIntegrityALG",
"dhGroup": "Modp8192"
}
]
},
"espSecurityAssociation": {
"espProposalType": "Specific",
"espProposals": [
{
"encAlg": "AES128",
"authAlg": "SHA1",
"dhGroup": "Modp2048"
},
{
"encAlg": "ThreeDES",
"authAlg": "MD5",
"dhGroup": "Modp8192"
}
]
},
"ikeRekeyTime": 0,
"ikeRekeyTimeUnit": "hour",
"espRekeyTime": 0,
"espRekeyTimeUnit": "day",
"cmProtocolOption": {
"cmpDhcpOpt43Subcode": 55,
"cmpServerAddr": "cmp test addr",
"cmpServerPath": "cmp test path"
},
"advancedOption": {
"dhcpOpt43Subcode": 8,
"retryLimit": 6,
"replayWindow": 30,
"ipcompEnable": "Enabled",
"enforceNatt": "Enabled",
"dpdDelay": 11,
"keepAliveIntval": 2,
"failoverRetryPeriod": 5,
"failoverRetryInterval": 6,
"failoverMode": "Revertive",
"failoverPrimaryCheckInterval": 7
},
"ipMode": "IPV4"
}
]
}
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 ipsec profile",
"type": "string"
},
"name": {
"description": "name of the ipsec profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the ipsec profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"serverAddr": {
"description": "server Addr of the ipsec profile",
"type": "string"
},
"authType": {
"description": "authentication type of the ipsec profile",
"enum": [
"PresharedKey",
"Certificate"
]
},
"preSharedKey": {
"description": "authentication preShared Key of the ipsec profile",
"type": "string"
},
"ikeSecurityAssociation": {
"description": "ikeProposal Security Association Content",
"type": "object",
"properties": {
"ikeProposalType": {
"description": "ikeProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"ikeProposals": {
"type": "array",
"description": "ikeProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "IkeProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of ikeProposal Specific",
"enum": [
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of ikeProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"prfAlg": {
"description": "prfAlg of ikeProposal Specific",
"enum": [
"UseIntegrityALG",
"PRF_MD5",
"PRF_SHA1",
"PRF_AES_CBC",
"PRF_AES_MAC",
"PRF_SHA256",
"PRF_SHA384",
"PRF_SHA512"
]
},
"dhGroup": {
"description": "dhGroup of ikeProposal Specific",
"enum": [
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"prfAlg",
"dhGroup"
]
}
}
}
},
"espSecurityAssociation": {
"description": "espProposal Security Association Content",
"type": "object",
"properties": {
"espProposalType": {
"description": "espProposal Type of the ipsec profile",
"enum": [
"Default",
"Specific"
]
},
"espProposals": {
"type": "array",
"description": "espProposal list of the ipsec profile",
"items": {
"type": "object",
"description": "EspProposal based ipsec service mappings",
"properties": {
"encAlg": {
"description": "encAlg of espProposal Specific",
"enum": [
"None",
"ThreeDES",
"AES128",
"AES192",
"AES256"
]
},
"authAlg": {
"description": "authAlg of espProposal Specific",
"enum": [
"MD5",
"SHA1",
"AESXCBC",
"SHA256",
"SHA384",
"SHA512"
]
},
"dhGroup": {
"description": "dhGroup of espProposal Specific",
"enum": [
"None",
"Modp768",
"Modp1024",
"Modp1536",
"Modp2048",
"Modp3072",
"Modp4096",
"Modp6144",
"Modp8192"
]
}
},
"required": [
"encAlg",
"authAlg",
"dhGroup"
]
}
}
}
},
"ikeRekeyTime": {
"description": "ikeRekey Time of the ipsec profile",
"type": "number"
},
"ikeRekeyTimeUnit": {
"description": "time unit",
"enum": [
"second",
"minute",
"hour",
"day"
]
},
"espRekeyTime": {
"description": "espRekey Time of the ipsec profile",
"type": "number"
},
"espRekeyTimeUnit": {
"description": "time unit",
"enum": [
"second",
"minute",
"hour",
"day"
]
},
"cmProtocolOption": {
"description": "Certificate Management Protocol Option",
"type": "object",
"properties": {
"cmpDhcpOpt43Subcode": {
"description": "Certificate Management Protocol dhcpOpt43Subcode",
"type": "number"
},
"cmpServerAddr": {
"description": "Certificate Management Protocol Server addr",
"type": "string"
},
"cmpServerPath": {
"description": "Certificate Management Protocol Server Path",
"type": "string"
},
"cmpDhcpOpt43SubcodeRecipient": {
"description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
"type": "number"
},
"cmpRecipient": {
"description": "Certificate Management Protocol Recipient",
"type": "string"
}
},
"required": [
"cmpDhcpOpt43Subcode"
]
},
"advancedOption": {
"description": "advanced option Content",
"type": "object",
"properties": {
"dhcpOpt43Subcode": {
"description": "dhcpOpt43Subcode of the ipsec profile",
"type": "number"
},
"retryLimit": {
"description": "retryLimit of the ipsec profile",
"type": "number"
},
"replayWindow": {
"description": "replayWindow of the ipsec profile",
"type": "number"
},
"ipcompEnable": {
"description": "ipcomp Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"enforceNatt": {
"description": "enforceNatt Enable of the ipsec profile",
"enum": [
"Disabled",
"Enabled"
]
},
"dpdDelay": {
"description": "dpdDelay of the ipsec profile",
"type": "number"
},
"keepAliveIntval": {
"description": "keepAliveIntval of the ipsec profile",
"type": "number"
},
"failoverRetryPeriod": {
"description": "Retry Period of the failover",
"type": "number"
},
"failoverRetryInterval": {
"description": "Retry Interval of the failover",
"type": "number"
},
"failoverMode": {
"description": "mode of the failover",
"enum": [
"Non_Revertive",
"Revertive"
]
},
"failoverPrimaryCheckInterval": {
"description": "Primary Check Interval of the failover",
"type": "number"
}
}
},
"ipMode": {
"description": "ipMode of the ipsec profile",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"domainId": {
"description": "Domain id of the IPSec profile",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
Hotspot20 Wi-Fi Operator Profile ¶
Retrieve List ¶
GET/v6_1/profiles/hs20/operators
Use this API command to retrieve list of Hotspot 2.0 Wi-Fi Operators.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "78311870-e9d8-11e6-952e-64006a6a50c6",
"name": "hs20Op",
"description": "",
"domainNames": [
"ruckuswireless.com"
],
"friendlyNames": [
{
"language": "English",
"name": "ruckwifi"
}
],
"certificate": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createDateTime": 1486102662007,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486102662007,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}
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 profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 Wifi operator profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 Wifi operator profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"domainNames" : {
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
},
"friendlyNames" : {
"description" : "Friendly names",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 32
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Signup security certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
},
"required" : [ "name", "domainNames", "friendlyNames" ]
}
},
"extra" : {
"type" : "object",
"properties" : {
"rbacMetadata" : {
"type" : "array",
"items" : {
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/profiles/hs20/operators/{id}
Use this API command to retrieve a Hotspot 2.0 Wi-Fi operator.
200
Body
{
"name": "public-api-operator",
"description": "description-changed",
"domainNames": [
"ruckus.com"
],
"friendlyNames": [
{
"language": "English",
"name": "ruckus"
}
],
"certificate": {
"id": "certificateID",
"name": "certificateName"
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 Wifi operator profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 Wifi operator profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"domainNames" : {
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
},
"friendlyNames" : {
"description" : "Friendly names",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 32
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Signup security certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
},
"required" : [ "name", "domainNames", "friendlyNames" ]
}
Create ¶
POST/v6_1/profiles/hs20/operators
Use this API command to create a new Hotspot 2.0 Wi-Fi operator.
Body
{
"name": "public-api-operator",
"description": "description-changed",
"domainNames": [
"ruckus.com"
],
"friendlyNames": [
{
"language": "English",
"name": "ruckus"
}
],
"certificate": {
"id": "certificateID",
"name": "certificateName"
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 Wifi operator profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 Wifi operator profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"domainNames" : {
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
},
"friendlyNames" : {
"description" : "Friendly names",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 32
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Signup security certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
},
"required" : [ "name", "domainNames", "friendlyNames" ]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/hs20/operators/{id}
Use this API command to modify the basic information of a Hotspot 2.0 Wi-Fi operator.
Body
{
"name": "public-api-operator-changed",
"description": "description-changed",
"domainNames": [
"ruckus.com"
],
"friendlyNames": [
{
"language": "English",
"name": "ruckus"
}
],
"certificate": {
"id": "certificateID",
"name": "certificateName"
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 Wifi operator profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 Wifi operator profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"domainNames" : {
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
},
"friendlyNames" : {
"description" : "Friendly names",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 32
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Signup security certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
}
}
}
204
Modify Domain Names ¶
PATCH/v6_1/profiles/hs20/operators/{id}/domainNames
Use this API command to modify domain names of a Hotspot 2.0 Wi-Fi operator.
Body
[
"ruckus.com"
]
Schema
{
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
204
Modify Friendly Names ¶
PATCH/v6_1/profiles/hs20/operators/{id}/friendlyNames
Use this API command to modify friendly names of a Hotspot 2.0 Wi-Fi operator.
Body
[
{
"language": "English",
"name": "ruckus"
}
]
Schema
{
"description": "Friendly names",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"description": "Language of the friendly name",
"enum": [
"English",
"Chinese",
"Czech",
"Danish",
"Dutch",
"French",
"German",
"Japanese",
"Spanish",
"Korean",
"Swedish",
"Turkish",
"eng",
"chi",
"cze",
"dan",
"dut",
"fre",
"ger",
"jpn",
"kor",
"spa",
"swe",
"tur"
]
},
"name": {
"description": "Name of the friendly name",
"type": "string",
"minLength": 2,
"maxLength": 32
}
},
"required": [
"language",
"name"
]
}
}
204
Modify Certificate ¶
PATCH/v6_1/profiles/hs20/operators/{id}/certificate
Use this API command to enable or modify certificate of a Hotspot 2.0 Wi-Fi operator.
Body
{
"id": "certificateID",
"name": "certificateName"
}
Schema
{
"description": "Signup security certificate",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Disable Certificate ¶
DELETE/v6_1/profiles/hs20/operators/{id}/certificate
Use this API command to disable certificate of a Hotspot 2.0 Wi-Fi operator.
204
Delete ¶
DELETE/v6_1/profiles/hs20/operators/{id}
Use this API command to delete a Hotspot 2.0 Wi-Fi operator.
204
Delete ¶
DELETE/v6_1/profiles/hs20/operators
Use this API command to delete multiple Hotspot 2.0 Wi-Fi operators.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Query hotspot 2.0 Wi-Fi operators ¶
POST/v6_1/profiles/hs20/operators/query
Query hotspot 2.0 Wi-Fi operators. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "78311870-e9d8-11e6-952e-64006a6a50c6",
"name": "hs20Op",
"description": "",
"domainNames": [
"ruckuswireless.com"
],
"friendlyNames": [
{
"language": "English",
"name": "ruckwifi"
}
],
"certificate": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createDateTime": 1486102662007,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486102662007,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}
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 profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 Wifi operator profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 Wifi operator profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"domainNames" : {
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
},
"friendlyNames" : {
"description" : "Friendly names",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 32
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Signup security certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
},
"required" : [ "name", "domainNames", "friendlyNames" ]
}
},
"extra" : {
"type" : "object",
"properties" : {
"rbacMetadata" : {
"type" : "array",
"items" : {
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
}
}
Hotspot20 Identity Provider Profile ¶
Retrieve List ¶
GET/v6_1/profiles/hs20/identityproviders
Use this API command to retrieve list of Hotspot 2.0 identity providers.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "b6df2529-db89-468e-aa57-94713f8af414",
"name": "hs20Provider",
"description": "",
"realms": [
{
"name": "123",
"encoding": "RFC4282",
"eapMethods": [
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
}
]
}
],
"plmns": [
{
"mcc": "123",
"mnc": "123"
}
],
"homeOis": null,
"authentications": [
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"vlanId": null
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"vlanId": null
}
],
"accountings": null,
"osu": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createDateTime": 1486102871106,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486102871106,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}
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 Hotspot 2.0 identity provider profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 identity provider profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 identity provider profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"realms" : {
"description" : "Realms",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of realm",
"type" : "string",
"minLength" : 2,
"maxLength" : 243,
"pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
},
"encoding" : {
"description" : "Encoding",
"enum" : [ "RFC4282", "UTF8" ]
},
"eapMethods" : {
"description" : "EAP methods",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "EAP method type",
"enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
},
"authSettings" : {
"description" : "EAP method auth settings",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"info" : {
"description" : "EAP auth info",
"enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
},
"type" : {
"description" : "EAP auth type",
"type" : "string"
},
"vendorId" : {
"description" : "EAP auth vendor ID",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 16777215
},
"vendorType" : {
"description" : "EAP auth vendor type",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4294967295
}
},
"required" : [ "info" ]
}
}
},
"required" : [ "type" ]
}
}
},
"required" : [ "name", "encoding", "eapMethods" ]
}
},
"plmns" : {
"description" : "PLMNs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mcc" : {
"description" : "MCC",
"type" : "string",
"pattern" : "^[0-9]{3}$"
},
"mnc" : {
"description" : "MNC",
"type" : "string",
"pattern" : "^[0-9]{2,3}$"
}
},
"required" : [ "mcc", "mnc" ]
}
},
"homeOis" : {
"description" : "Home OIs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the home OI",
"type" : "string",
"maxLength" : 255
},
"oi" : {
"description" : "Orgnization ID(3Hex or 5Hex)",
"type" : "string",
"pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required" : [ "name", "oi" ]
}
},
"authentications" : {
"description" : "Authentications",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Authentication id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Authentication name",
"type" : [ "string", "null" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Authentication service type",
"enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
},
"vlanId" : {
"description" : "Dynamic vlan ID",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType" ]
}
},
"accountings" : {
"description" : "Accountings",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Accounting id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Accounting name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Accounting service type",
"enum" : [ "NA", "RADIUS", "CGF" ]
}
},
"required" : [ "realm", "serviceType" ]
}
},
"osu" : {
"description" : "Online Signup & Provisioning",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"description" : "Internal online singup, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"description" : "Internal online singup portal, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"externalUrl" : {
"description" : "External online singup portal, start with https://, required when type is External",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Online signup certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ]
},
"externalOSU" : {
"description" : "External online singup, required when type is External",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"description" : "External service URL, start with https://",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
}
},
"required" : [ "type" ]
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
}
}
},
"extra" : {
"type" : "object",
"properties" : {
"rbacMetadata" : {
"type" : "array",
"items" : {
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/profiles/hs20/identityproviders/{id}
Use this API command to retrieve a Hotspot 2.0 identity provider.
200
Body
{
"id": "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "hs20IdentithInternalOSU",
"description": "",
"realms": [
{
"name": "reamlll",
"encoding": "RFC4282",
"eapMethods": [
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
}
]
}
],
"plmns": null,
"homeOis": null,
"authentications": [
{
"id": "868b0b20-8598-11e4-8acc-08002716c79f",
"name": "globalRadius",
"realm": "globalAuth",
"serviceType": "RADIUS",
"vlanId": 23,
"refBlank": false
},
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"vlanId": null,
"refBlank": true
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"vlanId": null,
"refBlank": true
}
],
"accountings": [
{
"id": "789ff6b0-8598-11e4-8acc-08002716c79f",
"name": "globalRadiusAcct",
"realm": "globalAcct",
"serviceType": "RADIUS",
"refBlank": false
},
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"refBlank": true
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"refBlank": true
}
],
"osu": {
"type": "Internal",
"internalOSU": {
"provisioningProtocals": [
"SOAP_XML"
],
"provisioningFormat": "R1_R2_ZEROIT",
"provisioningUpdateType": "NEVER",
"osuPortal": {
"type": "Internal",
"internalOSUPortal": {
"id": "24cdfc80-8598-11e4-8acc-08002716c79f",
"name": null,
"refBlank": false
},
"externalUrl": null
},
"commonLanguageIcon": "imageDATA",
"subscriptionDescriptions": [
{
"language": "English",
"name": "ruckus",
"description": "",
"icon": ""
}
],
"certificate": {
"id": "certificateID",
"name": "certificateName"
},
"osuAuthServices": [
{
"id": "11111111-1111-1111-1111-111111111111",
"name": null,
"credentialType": "LOCAL",
"realm": "reamlll",
"expiration": -1,
"refBlank": false
}
],
"whitelistedDomains": []
},
"externalOSU": null
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the Hotspot 2.0 identity provider profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 identity provider profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 identity provider profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"realms" : {
"description" : "Realms",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of realm",
"type" : "string",
"minLength" : 2,
"maxLength" : 243,
"pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
},
"encoding" : {
"description" : "Encoding",
"enum" : [ "RFC4282", "UTF8" ]
},
"eapMethods" : {
"description" : "EAP methods",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "EAP method type",
"enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
},
"authSettings" : {
"description" : "EAP method auth settings",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"info" : {
"description" : "EAP auth info",
"enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
},
"type" : {
"description" : "EAP auth type",
"type" : "string"
},
"vendorId" : {
"description" : "EAP auth vendor ID",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 16777215
},
"vendorType" : {
"description" : "EAP auth vendor type",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4294967295
}
},
"required" : [ "info" ]
}
}
},
"required" : [ "type" ]
}
}
},
"required" : [ "name", "encoding", "eapMethods" ]
}
},
"plmns" : {
"description" : "PLMNs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mcc" : {
"description" : "MCC",
"type" : "string",
"pattern" : "^[0-9]{3}$"
},
"mnc" : {
"description" : "MNC",
"type" : "string",
"pattern" : "^[0-9]{2,3}$"
}
},
"required" : [ "mcc", "mnc" ]
}
},
"homeOis" : {
"description" : "Home OIs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the home OI",
"type" : "string",
"maxLength" : 255
},
"oi" : {
"description" : "Orgnization ID(3Hex or 5Hex)",
"type" : "string",
"pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required" : [ "name", "oi" ]
}
},
"authentications" : {
"description" : "Authentications",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Authentication id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Authentication name",
"type" : [ "string", "null" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Authentication service type",
"enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
},
"vlanId" : {
"description" : "Dynamic vlan ID",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType" ]
}
},
"accountings" : {
"description" : "Accountings",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Accounting id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Accounting name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Accounting service type",
"enum" : [ "NA", "RADIUS", "CGF" ]
}
},
"required" : [ "realm", "serviceType" ]
}
},
"osu" : {
"description" : "Online Signup & Provisioning",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"description" : "Internal online singup, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"description" : "Internal online singup portal, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"externalUrl" : {
"description" : "External online singup portal, start with https://, required when type is External",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Online signup certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ]
},
"externalOSU" : {
"description" : "External online singup, required when type is External",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"description" : "External service URL, start with https://",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
}
},
"required" : [ "type" ]
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
}
}
Create ¶
POST/v6_1/profiles/hs20/identityproviders
Use this API command to create a new Hotspot 2.0 identity provider.
Body
{
"id": "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "hs20IdentithInternalOSU",
"description": "",
"realms": [
{
"name": "reamlll",
"encoding": "RFC4282",
"eapMethods": [
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
}
]
}
],
"plmns": null,
"homeOis": null,
"authentications": [
{
"id": "868b0b20-8598-11e4-8acc-08002716c79f",
"name": "globalRadius",
"realm": "globalAuth",
"serviceType": "RADIUS",
"vlanId": 23,
"refBlank": false
},
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"vlanId": null,
"refBlank": true
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"vlanId": null,
"refBlank": true
}
],
"accountings": [
{
"id": "789ff6b0-8598-11e4-8acc-08002716c79f",
"name": "globalRadiusAcct",
"realm": "globalAcct",
"serviceType": "RADIUS",
"refBlank": false
},
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"refBlank": true
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"refBlank": true
}
],
"osu": {
"type": "Internal",
"internalOSU": {
"provisioningProtocals": [
"SOAP_XML"
],
"provisioningFormat": "R1_R2_ZEROIT",
"provisioningUpdateType": "NEVER",
"osuPortal": {
"type": "Internal",
"internalOSUPortal": {
"id": "24cdfc80-8598-11e4-8acc-08002716c79f",
"name": null,
"refBlank": false
},
"externalUrl": null
},
"commonLanguageIcon": "imageDATA",
"subscriptionDescriptions": [
{
"language": "English",
"name": "ruckus",
"description": "",
"icon": ""
}
],
"certificate": {
"id": "certificateID",
"name": "certificateName"
},
"osuAuthServices": [
{
"id": "11111111-1111-1111-1111-111111111111",
"name": null,
"credentialType": "LOCAL",
"realm": "reamlll",
"expiration": -1,
"refBlank": false
}
],
"whitelistedDomains": []
},
"externalOSU": null
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the Hotspot 2.0 identity provider profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 identity provider profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 identity provider profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"realms" : {
"description" : "Realms",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of realm",
"type" : "string",
"minLength" : 2,
"maxLength" : 243,
"pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
},
"encoding" : {
"description" : "Encoding",
"enum" : [ "RFC4282", "UTF8" ]
},
"eapMethods" : {
"description" : "EAP methods",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "EAP method type",
"enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
},
"authSettings" : {
"description" : "EAP method auth settings",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"info" : {
"description" : "EAP auth info",
"enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
},
"type" : {
"description" : "EAP auth type",
"type" : "string"
},
"vendorId" : {
"description" : "EAP auth vendor ID",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 16777215
},
"vendorType" : {
"description" : "EAP auth vendor type",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4294967295
}
},
"required" : [ "info" ]
}
}
},
"required" : [ "type" ]
}
}
},
"required" : [ "name", "encoding", "eapMethods" ]
}
},
"plmns" : {
"description" : "PLMNs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mcc" : {
"description" : "MCC",
"type" : "string",
"pattern" : "^[0-9]{3}$"
},
"mnc" : {
"description" : "MNC",
"type" : "string",
"pattern" : "^[0-9]{2,3}$"
}
},
"required" : [ "mcc", "mnc" ]
}
},
"homeOis" : {
"description" : "Home OIs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the home OI",
"type" : "string",
"maxLength" : 255
},
"oi" : {
"description" : "Orgnization ID(3Hex or 5Hex)",
"type" : "string",
"pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required" : [ "name", "oi" ]
}
},
"authentications" : {
"description" : "Authentications",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Authentication id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Authentication name",
"type" : [ "string", "null" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Authentication service type",
"enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
},
"vlanId" : {
"description" : "Dynamic vlan ID",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType" ]
}
},
"accountings" : {
"description" : "Accountings",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Accounting id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Accounting name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Accounting service type",
"enum" : [ "NA", "RADIUS", "CGF" ]
}
},
"required" : [ "realm", "serviceType" ]
}
},
"osu" : {
"description" : "Online Signup & Provisioning",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"description" : "Internal online singup, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"description" : "Internal online singup portal, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"externalUrl" : {
"description" : "External online singup portal, start with https://, required when type is External",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Online signup certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ]
},
"externalOSU" : {
"description" : "External online singup, required when type is External",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"description" : "External service URL, start with https://",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
}
},
"required" : [ "type" ]
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
}
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/hs20/identityproviders/{id}
Use this API command to modify the basic information of a Hotspot 2.0 identity provider.
Body
{
"id": "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "hs20IdentithInternalOSU",
"description": "",
"realms": [
{
"name": "reamlll",
"encoding": "RFC4282",
"eapMethods": [
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
}
]
}
],
"plmns": null,
"homeOis": null,
"authentications": [
{
"id": "868b0b20-8598-11e4-8acc-08002716c79f",
"name": "globalRadius",
"realm": "globalAuth",
"serviceType": "RADIUS",
"vlanId": 23,
"refBlank": false
},
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"vlanId": null,
"refBlank": true
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"vlanId": null,
"refBlank": true
}
],
"accountings": [
{
"id": "789ff6b0-8598-11e4-8acc-08002716c79f",
"name": "globalRadiusAcct",
"realm": "globalAcct",
"serviceType": "RADIUS",
"refBlank": false
},
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"refBlank": true
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"refBlank": true
}
],
"osu": {
"type": "Internal",
"internalOSU": {
"provisioningProtocals": [
"SOAP_XML"
],
"provisioningFormat": "R1_R2_ZEROIT",
"provisioningUpdateType": "NEVER",
"osuPortal": {
"type": "Internal",
"internalOSUPortal": {
"id": "24cdfc80-8598-11e4-8acc-08002716c79f",
"name": null,
"refBlank": false
},
"externalUrl": null
},
"commonLanguageIcon": "imageDATA",
"subscriptionDescriptions": [
{
"language": "English",
"name": "ruckus",
"description": "",
"icon": ""
}
],
"certificate": {
"id": "certificateID",
"name": "certificateName"
},
"osuAuthServices": [
{
"id": "11111111-1111-1111-1111-111111111111",
"name": null,
"credentialType": "LOCAL",
"realm": "reamlll",
"expiration": -1,
"refBlank": false
}
],
"whitelistedDomains": []
},
"externalOSU": null
}
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the Hotspot 2.0 identity provider profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 identity provider profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 identity provider profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"realms" : {
"description" : "Realms",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of realm",
"type" : "string",
"minLength" : 2,
"maxLength" : 243,
"pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
},
"encoding" : {
"description" : "Encoding",
"enum" : [ "RFC4282", "UTF8" ]
},
"eapMethods" : {
"description" : "EAP methods",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "EAP method type",
"enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
},
"authSettings" : {
"description" : "EAP method auth settings",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"info" : {
"description" : "EAP auth info",
"enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
},
"type" : {
"description" : "EAP auth type",
"type" : "string"
},
"vendorId" : {
"description" : "EAP auth vendor ID",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 16777215
},
"vendorType" : {
"description" : "EAP auth vendor type",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4294967295
}
},
"required" : [ "info" ]
}
}
},
"required" : [ "type" ]
}
}
},
"required" : [ "name", "encoding", "eapMethods" ]
}
},
"plmns" : {
"description" : "PLMNs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mcc" : {
"description" : "MCC",
"type" : "string",
"pattern" : "^[0-9]{3}$"
},
"mnc" : {
"description" : "MNC",
"type" : "string",
"pattern" : "^[0-9]{2,3}$"
}
},
"required" : [ "mcc", "mnc" ]
}
},
"homeOis" : {
"description" : "Home OIs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the home OI",
"type" : "string",
"maxLength" : 255
},
"oi" : {
"description" : "Orgnization ID(3Hex or 5Hex)",
"type" : "string",
"pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required" : [ "name", "oi" ]
}
},
"authentications" : {
"description" : "Authentications",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Authentication id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Authentication name",
"type" : [ "string", "null" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Authentication service type",
"enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
},
"vlanId" : {
"description" : "Dynamic vlan ID",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType" ]
}
},
"accountings" : {
"description" : "Accountings",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Accounting id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Accounting name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Accounting service type",
"enum" : [ "NA", "RADIUS", "CGF" ]
}
},
"required" : [ "realm", "serviceType" ]
}
},
"osu" : {
"description" : "Online Signup & Provisioning",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"description" : "Internal online singup, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"description" : "Internal online singup portal, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"externalUrl" : {
"description" : "External online singup portal, start with https://, required when type is External",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Online signup certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ]
},
"externalOSU" : {
"description" : "External online singup, required when type is External",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"description" : "External service URL, start with https://",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
}
},
"required" : [ "type" ]
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
}
}
204
Modify Realms ¶
PATCH/v6_1/profiles/hs20/identityproviders/{id}/realms
Use this API command to modify realms of a Hotspot 2.0 identity provider.
Body
[
{
"name": "reamlll",
"encoding": "RFC4282",
"eapMethods": [
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
}
]
}
]
Schema
{
"description": "Realms",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of realm",
"type": "string",
"minLength": 2,
"maxLength": 243,
"pattern": "^[!-~]([ -~]){0,241}[!-~]$"
},
"encoding": {
"description": "Encoding",
"enum": [
"RFC4282",
"UTF8"
]
},
"eapMethods": {
"description": "EAP methods",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "EAP method type",
"enum": [
"NA",
"MD5",
"EAP_TLS",
"EAP_Cisco",
"EAP_SIM",
"EAP_TTLS",
"EAP_AKA",
"PEAP",
"EAP_MSCHAP_V2",
"EAP_AKAs",
"Reserved"
]
},
"authSettings": {
"description": "EAP method auth settings",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"info": {
"description": "EAP auth info",
"enum": [
"Expanded",
"Non",
"Inner",
"Expanded_Inner",
"Credential",
"Tunneled"
]
},
"type": {
"description": "EAP auth type",
"type": "string"
},
"vendorId": {
"description": "EAP auth vendor ID",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 16777215
},
"vendorType": {
"description": "EAP auth vendor type",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 4294967295
}
},
"required": [
"info"
]
}
}
},
"required": [
"type"
]
}
}
},
"required": [
"name",
"encoding",
"eapMethods"
]
}
}
204
Modify PLMNs ¶
PATCH/v6_1/profiles/hs20/identityproviders/{id}/plmns
Use this API command to modify PLMNs of a Hotspot 2.0 identity provider.
Body
null
Schema
{
"description": "PLMNs",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mcc": {
"description": "MCC",
"type": "string",
"pattern": "^[0-9]{3}$"
},
"mnc": {
"description": "MNC",
"type": "string",
"pattern": "^[0-9]{2,3}$"
}
},
"required": [
"mcc",
"mnc"
]
}
}
204
Modify Home OIs ¶
PATCH/v6_1/profiles/hs20/identityproviders/{id}/homeOis
Use this API command to modify home OIs of a Hotspot 2.0 identity provider.
Body
null
Schema
{
"description": "Home OIs",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the home OI",
"type": "string",
"maxLength": 255
},
"oi": {
"description": "Orgnization ID(3Hex or 5Hex)",
"type": "string",
"pattern": "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required": [
"name",
"oi"
]
}
}
204
Modify Authentications ¶
PATCH/v6_1/profiles/hs20/identityproviders/{id}/authentications
Use this API command to modify authentications of a Hotspot 2.0 identity provider.
Body
[
{
"id": "868b0b20-8598-11e4-8acc-08002716c79f",
"name": "globalRadius",
"realm": "globalAuth",
"serviceType": "RADIUS",
"vlanId": 23,
"refBlank": false
},
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"vlanId": null,
"refBlank": true
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"vlanId": null,
"refBlank": true
}
]
Schema
{
"description": "Authentications",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Authentication id",
"type": [
"string",
"null"
]
},
"name": {
"description": "Authentication name",
"type": [
"string",
"null"
]
},
"realm": {
"description": "Authentication realm",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Authentication service type",
"enum": [
"NA",
"LOCAL_DB",
"RADIUS",
"GUEST"
]
},
"vlanId": {
"description": "Dynamic vlan ID",
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 4094
}
},
"required": [
"realm",
"serviceType"
]
}
}
204
Modify Accountings ¶
PATCH/v6_1/profiles/hs20/identityproviders/{id}/accountings
Use this API command to modify accountings of a Hotspot 2.0 identity provider.
Body
[
{
"id": "789ff6b0-8598-11e4-8acc-08002716c79f",
"name": "globalRadiusAcct",
"realm": "globalAcct",
"serviceType": "RADIUS",
"refBlank": false
},
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"refBlank": true
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"refBlank": true
}
]
Schema
{
"description": "Accountings",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Accounting id",
"type": [
"string",
"null"
]
},
"name": {
"description": "Accounting name",
"type": [
"string",
"null"
]
},
"realm": {
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType": {
"description": "Accounting service type",
"enum": [
"NA",
"RADIUS",
"CGF"
]
}
},
"required": [
"realm",
"serviceType"
]
}
}
204
Disable Accountings ¶
DELETE/v6_1/profiles/hs20/identityproviders/{id}/accountings
Use this API command to disable accountings of a Hotspot 2.0 identity provider.
204
Modify Online Signup & Provisioning ¶
PATCH/v6_1/profiles/hs20/identityproviders/{id}/osu
Use this API command to modify online signup & provisioning of a Hotspot 2.0 identity provider.
Body
{
"type": "Internal",
"internalOSU": {
"provisioningProtocals": [
"SOAP_XML"
],
"provisioningFormat": "R1_R2_ZEROIT",
"provisioningUpdateType": "NEVER",
"osuPortal": {
"type": "Internal",
"internalOSUPortal": {
"id": "24cdfc80-8598-11e4-8acc-08002716c79f",
"name": null,
"refBlank": false
},
"externalUrl": null
},
"commonLanguageIcon": "imageDATA",
"subscriptionDescriptions": [
{
"language": "English",
"name": "ruckus",
"description": "",
"icon": ""
}
],
"certificate": {
"id": "certificateID",
"name": "certificateName"
},
"osuAuthServices": [
{
"id": "11111111-1111-1111-1111-111111111111",
"name": null,
"credentialType": "LOCAL",
"realm": "reamlll",
"expiration": -1,
"refBlank": false
}
],
"whitelistedDomains": []
},
"externalOSU": null
}
Schema
{
"description" : "Online Signup & Provisioning",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"description" : "Internal online singup, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"description" : "Internal online singup portal, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"externalUrl" : {
"description" : "External online singup portal, start with https://, required when type is External",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Online signup certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ]
},
"externalOSU" : {
"description" : "External online singup, required when type is External",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"description" : "External service URL, start with https://",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
}
},
"required" : [ "type" ]
}
204
Disable Online Signup & Provisioning ¶
DELETE/v6_1/profiles/hs20/identityproviders/{id}/osu
Use this API command to disable online signup & provisioning of a Hotspot 2.0 identity provider.
204
Delete ¶
DELETE/v6_1/profiles/hs20/identityproviders/{id}
Use this API command to delete a Hotspot 2.0 identity provider.
204
Delete ¶
DELETE/v6_1/profiles/hs20/identityproviders
Use this API command to delete multiple Hotspot 2.0 identity provider.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Query hotspot 2.0 identity provider ¶
POST/v6_1/profiles/hs20/identityproviders/query
Query hotspot 2.0 identity providers. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "b6df2529-db89-468e-aa57-94713f8af414",
"name": "hs20Provider",
"description": "",
"realms": [
{
"name": "123",
"encoding": "RFC4282",
"eapMethods": [
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
},
{
"type": "NA",
"authSettings": null
}
]
}
],
"plmns": [
{
"mcc": "123",
"mnc": "123"
}
],
"homeOis": null,
"authentications": [
{
"id": null,
"name": null,
"realm": "No Match",
"serviceType": "NA",
"vlanId": null
},
{
"id": null,
"name": null,
"realm": "Unspecified",
"serviceType": "NA",
"vlanId": null
}
],
"accountings": null,
"osu": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createDateTime": 1486102871106,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486102871106,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}
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 Hotspot 2.0 identity provider profile",
"type" : "string"
},
"name" : {
"description" : "Name of the Hotspot 2.0 identity provider profile",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the Hotspot 2.0 identity provider profile",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"realms" : {
"description" : "Realms",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of realm",
"type" : "string",
"minLength" : 2,
"maxLength" : 243,
"pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
},
"encoding" : {
"description" : "Encoding",
"enum" : [ "RFC4282", "UTF8" ]
},
"eapMethods" : {
"description" : "EAP methods",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "EAP method type",
"enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
},
"authSettings" : {
"description" : "EAP method auth settings",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"info" : {
"description" : "EAP auth info",
"enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
},
"type" : {
"description" : "EAP auth type",
"type" : "string"
},
"vendorId" : {
"description" : "EAP auth vendor ID",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 16777215
},
"vendorType" : {
"description" : "EAP auth vendor type",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4294967295
}
},
"required" : [ "info" ]
}
}
},
"required" : [ "type" ]
}
}
},
"required" : [ "name", "encoding", "eapMethods" ]
}
},
"plmns" : {
"description" : "PLMNs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mcc" : {
"description" : "MCC",
"type" : "string",
"pattern" : "^[0-9]{3}$"
},
"mnc" : {
"description" : "MNC",
"type" : "string",
"pattern" : "^[0-9]{2,3}$"
}
},
"required" : [ "mcc", "mnc" ]
}
},
"homeOis" : {
"description" : "Home OIs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the home OI",
"type" : "string",
"maxLength" : 255
},
"oi" : {
"description" : "Orgnization ID(3Hex or 5Hex)",
"type" : "string",
"pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required" : [ "name", "oi" ]
}
},
"authentications" : {
"description" : "Authentications",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Authentication id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Authentication name",
"type" : [ "string", "null" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Authentication service type",
"enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
},
"vlanId" : {
"description" : "Dynamic vlan ID",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType" ]
}
},
"accountings" : {
"description" : "Accountings",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Accounting id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Accounting name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Accounting service type",
"enum" : [ "NA", "RADIUS", "CGF" ]
}
},
"required" : [ "realm", "serviceType" ]
}
},
"osu" : {
"description" : "Online Signup & Provisioning",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"description" : "Internal online singup, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"description" : "Internal online singup portal, required when type is Internal",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"externalUrl" : {
"description" : "External online singup portal, start with https://, required when type is External",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"description" : "Online signup certificate",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"description" : "Authentication realm",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ]
},
"externalOSU" : {
"description" : "External online singup, required when type is External",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"description" : "External service URL, start with https://",
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language of the friendly name",
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
},
"name" : {
"description" : "Name of the friendly name",
"type" : "string",
"minLength" : 2,
"maxLength" : 252
},
"description" : {
"description" : "Description of the friendly name",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
}
},
"required" : [ "type" ]
},
"domainId" : {
"description" : "Domain Id",
"type" : "string"
},
"createDateTime" : {
"description" : "Timestamp of being created",
"type" : "integer"
},
"modifiedDateTime" : {
"description" : "Timestamp of being modified",
"type" : "integer"
},
"creatorId" : {
"description" : "Creator ID",
"type" : "string"
},
"modifierId" : {
"description" : "Modifier ID",
"type" : "string"
},
"creatorUsername" : {
"description" : "Creator Name",
"type" : "string"
},
"modifierUsername" : {
"description" : "Modifier Name",
"type" : "string"
}
}
}
},
"extra" : {
"type" : "object",
"properties" : {
"rbacMetadata" : {
"type" : "array",
"items" : {
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
}
}
Certificate ¶
Retrieve Certificate List ¶
GET/v6_1/certstore/certificate
Use this API command to retrieve list of installed certificates.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "rootCertificate",
"name": "rootCertificate",
"description": "root certificate description"
},
{
"id": "hs20Certificate",
"name": "hs20Certificate",
"description": "Hotspot20 certificate description"
}
]
}
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 certificate",
"type": "string"
},
"name": {
"description": "Name of the certificate",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the certificate",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
}
}
}
Retrieve Certificate ¶
GET/v6_1/certstore/certificate/{id}
Use this API command to retrieve an installed certificate.
200
Body
{
"id": "certificateID",
"name": "certificateName",
"description": "certificate description",
"data": "certificateData",
"information": "certificateInformation",
"intermediateData": [
"intermediateCertifcateData1",
"intermediateCertifcateData2"
],
"rootData": "rootCertificateData",
"privateKeyData": "privateKeyData",
"certificasSigningRequest": null,
"passphrase": "passphrase"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the certificate",
"type": "string"
},
"name": {
"description": "Name of the certificate",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the certificate",
"type": [
"string",
"null"
],
"maxLength": 64
},
"data": {
"description": "Data of the certificate",
"type": "string"
},
"information": {
"description": "Information of the certificate",
"type": "string"
},
"intermediateData": {
"description": "Intermediate data of the certificate",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"rootData": {
"description": "Root data of the certificate",
"type": "string"
},
"privateKeyData": {
"description": "Private key data of the certificate",
"type": "string"
},
"certificasSigningRequest": {
"description": "Certificates signing request of the certificate",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"passphrase": {
"description": "Key passphrase",
"type": "string"
}
}
}
Retrieve Certificate Setting ¶
GET/v6_1/certstore/setting
Use this API command to retrieve certificate setting.
200
Body
{
"serviceCertificates": [
{
"service": "MANAGEMENT_WEB",
"certificate": {
"id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
"name": "newcert"
}
},
{
"service": "AP_PORTAL",
"certificate": {
"id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
"name": "newcert"
}
},
{
"service": "HOTSPOT",
"certificate": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Default Certificate"
}
},
{
"service": "COMMUNICATOR",
"certificate": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Default Certificate"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"serviceCertificates": {
"description": "Certificate Setting of the service",
"type": [
"array"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"service": {
"description": "the service",
"enum": [
"MANAGEMENT_WEB",
"AP_PORTAL",
"HOTSPOT",
"COMMUNICATOR"
]
},
"certificate": {
"description": "certificate of the service",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"service"
]
}
}
}
}
Retrieve CSR List ¶
GET/v6_1/certstore/csr
Use this API command to retrieve list of certificates signing request.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "privateKey1",
"name": "privateKey1",
"description": "private key1 description"
},
{
"id": "privateKey2",
"name": "privateKey2",
"description": "private key2 description"
}
]
}
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 certificates signing request",
"type": "string"
},
"name": {
"description": "Name of the certificates signing request",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the certificates signing request",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
}
}
}
Retrieve CSR ¶
GET/v6_1/certstore/csr/{id}
Use this API command to retrieve a certificates signing request.
200
Body
{
"id": "csrID",
"name": "csr-test",
"commonName": "ruckus.com",
"email": "[email protected]",
"organization": "org",
"organizationUnit": "orgUnit",
"city": "shenzhen",
"state": "guangdong",
"countryCode": "US"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the certificates signing request",
"type": "string"
},
"name": {
"description": "Name of the certificates signing request",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the certificates signing request",
"type": [
"string",
"null"
],
"maxLength": 64
},
"commonName": {
"description": "Common name of the certificates signing request",
"type": "string"
},
"email": {
"description": "Email of the certificates signing request",
"type": "string"
},
"organization": {
"description": "Organization of the certificates signing request",
"type": "string"
},
"organizationUnit": {
"description": "Organization unit of the certificates signing request",
"type": "string"
},
"city": {
"description": "City of the certificates signing request",
"type": "string"
},
"state": {
"description": "State of the certificates signing request",
"type": "string"
},
"countryCode": {
"description": "Country code of the certificates signing request",
"type": "string"
}
}
}
Create Certificate ¶
POST/v6_1/certstore/certificate
Use this API command to create an installed certificate.
Body
{
"name": "hs20Certificate",
"description": "Hotspot20 certificate description",
"data": "certificateData",
"intermediateData": [
"intermediateCertifcateData1",
"intermediateCertifcateData2"
],
"rootData": "rootCertificateData",
"privateKeyData": "privateKeyData",
"passphrase": "passphrase"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the certificate",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the certificate",
"type": [
"string",
"null"
],
"maxLength": 64
},
"data": {
"description": "Data of the certificate",
"type": "string"
},
"intermediateData": {
"description": "Intermediate data of the certificate",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"rootData": {
"description": "Root data of the certificate",
"type": "string"
},
"privateKeyData": {
"description": "Private key data of the certificate",
"type": "string"
},
"certificasSigningRequest": {
"description": "Certificates signing request of the certificate",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"passphrase": {
"description": "Key passphrase",
"type": "string"
}
},
"required": [
"name",
"data"
]
}
201
Body
{
"id": "certificateUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/certstore/setting
Use this API command to Modify the Certificate Setting.
Body
{
"serviceCertificates": [
{
"service": "MANAGEMENT_WEB",
"certificate": {
"id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
"name": "newcert"
}
},
{
"service": "AP_PORTAL",
"certificate": {
"id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
"name": "newcert"
}
},
{
"service": "HOTSPOT",
"certificate": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Default Certificate"
}
},
{
"service": "COMMUNICATOR",
"certificate": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Default Certificate"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"serviceCertificates": {
"description": "Certificate Setting of the service",
"type": [
"array"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"service": {
"description": "the service",
"enum": [
"MANAGEMENT_WEB",
"AP_PORTAL",
"HOTSPOT",
"COMMUNICATOR"
]
},
"certificate": {
"description": "certificate of the service",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"service"
]
}
}
}
}
204
Modify serviceCertificates ¶
PATCH/v6_1/certstore/setting/serviceCertificates
Use this API command to Modify serviceCertificates of the Certificate Setting.
Body
[
{
"service": "MANAGEMENT_WEB",
"certificate": {
"id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
"name": "newcert"
}
},
{
"service": "AP_PORTAL",
"certificate": {
"id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
"name": "newcert"
}
},
{
"service": "HOTSPOT",
"certificate": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Default Certificate"
}
},
{
"service": "COMMUNICATOR",
"certificate": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Default Certificate"
}
}
]
Schema
{
"description": "Certificate Setting of the service",
"type": [
"array"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"service": {
"description": "the service",
"enum": [
"MANAGEMENT_WEB",
"AP_PORTAL",
"HOTSPOT",
"COMMUNICATOR"
]
},
"certificate": {
"description": "certificate of the service",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"service"
]
}
}
204
Create CSR ¶
POST/v6_1/certstore/csr
Use this API command to create a certificates signing request.
Body
{
"name": "csr-test",
"commonName": "ruckus.com",
"email": "[email protected]",
"organization": "org",
"city": "shenzhen",
"state": "guangdong",
"countryCode": "US"
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the certificates signing request",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the certificates signing request",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"commonName" : {
"description" : "Common name of the certificates signing request",
"type" : "string",
"pattern" : "^(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}$"
},
"email" : {
"description" : "Email of the certificates signing request",
"type" : "string",
"pattern" : "^(\w+)([\-+.\'][\w]+)*@(\w[\-\w]*\.){1,255}([A-Za-z]){2,6}$"
},
"organization" : {
"description" : "Organization of the certificates signing request",
"type" : "string",
"maxLength" : 64
},
"organizationUnit" : {
"description" : "Organization unit of the certificates signing request",
"type" : "string",
"maxLength" : 64
},
"city" : {
"description" : "City of the certificates signing request",
"type" : "string",
"maxLength" : 128
},
"state" : {
"description" : "State of the certificates signing request",
"type" : "string",
"maxLength" : 128
},
"countryCode" : {
"description" : "Country code of the certificates signing request",
"type" : "string"
}
},
"required" : [ "name", "commonName", "email", "organization", "city", "state", "countryCode" ]
}
201
Body
{
"id": "certificateUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Delete Certificate ¶
DELETE/v6_1/certstore/certificate/{id}
Use this API command to delete an installed certificate.
204
Delete CSR ¶
DELETE/v6_1/certstore/csr/{id}
Use this API command to delete a certificates signing request.
204
Retrieve Trusted CA Chain Certificates List ¶
GET/v6_1/certstore/trustedCAChainCert
Use this API command to retrieve list of installed trusted CA chain certificates.
- 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
200
Body
{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "rootCertificate",
"name" : "rootCertificate",
"description" : "root certificate description",
"interCertData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
"rootCertData" : "rootCertificateData"
}, {
"id" : "hs20Certificate",
"name" : "hs20Certificate",
"description" : "Hotspot20 certificate description",
"information" : "\n\n-----BEGIN INTERMEDIATE CERTIFICATE #1 -----\n[\n[\n Version: V3\n Subject: CN=Verizon Hotspot 2.0 Intermediate CA, OU=Cybertrust, O=Verizon Enterprise Solutions, L=Amsterdam, C=NL\n Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n Key: Sun RSA public key, 2048 bits\n modulus: 23617561117988111216066421024092057505707971583866555863467960236740199253262690005512455723125315310387461393165651970748842793301611918034442594711994634192423187372806761353350113250438225110389282744014438367665821734885051972120241834680068338044857354569175288575440030311710708015575344394358723355054477230016829047631782713506713276018655043123697918236044268053319322704458844413722254348232276124596584542075041243826757391193963245254337908100807532825175242207243382889107249881414575066011404307393987338973084479538528154253484161987803827349486330380817232385299053004582804890215693233201596774334823\n public exponent: 65537\n Validity: [From: Mon Aug 11 18:44:39 UTC 2014,\n To: Sun Aug 11 18:44:09 UTC 2024]\n Issuer: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n SerialNumber: [ cb]\n\nCertificate Extensions: 6\n[1]: ObjectId: 1.3.6.1.5.5.7.1.1 Criticality=false\nAuthorityInfoAccess [\n [\n accessMethod: ocsp\n accessLocation: URIName: http://ocsp.omniroot.com/hotspotroot\n]\n]\n\n[2]: ObjectId: 2.5.29.35 Criticality=false\nAuthorityKeyIdentifier [\nKeyIdentifier [\n0000: E4 2F 5C D4 E3 2C 07 EF CC 3B 09 7D 38 A1 B6 0F ./\..,...;..8...\n0010: F5 D2 C2 B5 ....\n]\n]\n\n[3]: ObjectId: 2.5.29.19 Criticality=true\nBasicConstraints:[\n CA:true\n PathLen:0\n]\n\n[4]: ObjectId: 2.5.29.32 Criticality=false\nCertificatePolicies [\n [CertificatePolicyId: [1.3.6.1.4.1.6334.1.600.1]\n[PolicyQualifierInfo: [\n qualifierID: 1.3.6.1.5.5.7.2.1\n qualifier: 0000: 16 27 20 68 74 74 70 73 3A 2F 2F 73 65 63 75 72 .' https://secur\n0010: 65 2E 6F 6D 6E 69 72 6F 6F 74 2E 63 6F 6D 2F 72 e.omniroot.com/r\n0020: 65 70 6F 73 69 74 6F 72 79 epository\n\n]] ]\n]\n\n[5]: ObjectId: 2.5.29.15 Criticality=true\nKeyUsage [\n DigitalSignature\n Non_repudiation\n Key_CertSign\n Crl_Sign\n]\n\n[6]: ObjectId: 2.5.29.14 Criticality=false\nSubjectKeyIdentifier [\nKeyIdentifier [\n0000: 5C 5D 9D B6 A0 47 88 1B 61 40 E1 B7 E6 42 CE 81 \][email protected]..\n0010: 2F 44 6E 40 /Dn@\n]\n]\n\n]\n Algorithm: [SHA256withRSA]\n Signature:\n0000: 86 44 36 50 5A F2 92 22 B1 CD F1 3F 76 46 D0 F2 .D6PZ..\"...?vF..\n0010: 21 71 E8 7C CD 15 67 69 F0 0A AE 07 34 61 B4 2F !q....gi....4a./\n0020: 9A 7F E1 70 5C 87 BA F5 62 6C D9 C9 C9 4D 38 15 ...p\...bl...M8.\n0030: C2 9A 3F 1A 9E 94 A3 2E EB 77 76 D7 46 75 0F EC ..?......wv.Fu..\n0040: C5 CF 38 EB 52 4E FC 3D 65 05 45 40 8B 17 12 87 ..8.RN.=e.E@....\n0050: FE E3 CB 47 46 2F DC 22 00 9D C6 20 05 53 11 0A ...GF/.\"... .S..\n0060: 4B 1B 01 4C 39 2F DA 4B 4F FF 65 06 39 36 05 82 K..L9/.KO.e.96..\n0070: 81 6F 9E E5 FB 9B AF 81 91 75 63 AF EC BA 7E D8 .o.......uc.....\n0080: 99 D2 B1 FA E6 34 68 DD 03 6F 9A FE FA F8 E7 12 .....4h..o......\n0090: D0 7E A8 34 2B 2F E2 A6 9D A9 84 38 4D 8F 58 14 ...4+/.....8M.X.\n00A0: FD A3 02 04 E9 81 74 BD E6 14 F7 69 32 E9 CF 17 ......t....i2...\n00B0: 7A 45 C7 0F F8 22 A8 7E A5 8A 26 8F 3B 06 45 86 zE...\"....&.;.E.\n00C0: 09 E8 D6 AB 35 E8 C1 E2 EC F2 A0 B6 8F 39 70 D8 ....5........9p.\n00D0: AF 71 80 2C E7 45 DE 6A 78 5A 98 B7 72 CD 73 B8 .q.,.E.jxZ..r.s.\n00E0: 33 4F 56 C7 95 58 13 B4 23 8D CC F1 BC 72 2A ED 3OV..X..#....r*.\n00F0: 70 20 CD 5F DD 47 99 BD E0 46 8E E2 37 86 0B F9 p ._.G...F..7...\n0100: 47 A4 5A EC F5 A4 93 C7 F4 C3 44 86 FA 00 C5 D1 G.Z.......D.....\n0110: FA C3 D8 72 1E 1E 66 3B 9E 44 51 0C 5B 41 29 AF ...r..f;.DQ.[A).\n0120: A1 73 9B 4E 27 BF 91 22 97 C6 B1 EC E8 48 A5 F5 .s.N'..\".....H..\n0130: EF 52 21 58 57 6B A3 4F 03 F8 D8 85 F4 8C 9F 8E .R!XWk.O........\n0140: 63 B4 15 D5 A4 AE 55 48 20 66 29 91 51 66 2A C2 c.....UH f).Qf*.\n0150: 37 64 2A F5 1B FC B0 9A 99 48 95 6E EF 20 50 D5 7d*......H.n. P.\n0160: E3 E6 22 BB 6F 99 11 5A A9 79 7E 56 EC B9 6A 54 ..\".o..Z.y.V..jT\n0170: C3 51 C2 1D 42 C1 90 1C 02 D0 21 2D AF 91 D4 31 .Q..B.....!-...1\n0180: 87 FA 62 4E 85 DF 2B 66 57 C4 B9 33 96 92 AA 44 ..bN..+fW..3...D\n0190: EC 8D 92 86 0B 7B AB DE D0 DC 3D E2 70 68 AD 68 ..........=.ph.h\n01A0: 84 E8 AC 51 2A D0 9B E4 D8 E8 EB FE F5 FC 0E 24 ...Q*..........$\n01B0: 49 2C F1 A7 4E CE B2 A7 13 20 35 E6 C7 E5 FA D2 I,..N.... 5.....\n01C0: D4 45 7B 02 60 3E CD E9 A6 DB B1 5A 61 B7 D2 E2 .E..`>.....Za...\n01D0: 5F A5 7E 68 14 39 9A 8D 2A 05 5A 73 EF E2 74 BE _..h.9..*.Zs..t.\n01E0: F2 7B D4 42 0D 83 32 78 43 EC 7E 9B C2 4D FD 8A ...B..2xC....M..\n01F0: 3A 5B 2B 2F 11 DC 3D 30 EC F5 E5 7D 07 BD F2 FF :[+/..=0........\n\n]\n-----END INTERMEDIATE CERTIFICATE #1 -----\n\n\n-----BEGIN ROOT CERTIFICATE-----\n[\n[\n Version: V3\n Subject: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n Key: Sun RSA public key, 4096 bits\n modulus: 792638386379776963560612627326855893912470807469865669361657331704603816803537228716538884420089923713620126175365944334916415693271509111815409260473015474112479914130474130953326558757576918270442304172218244844002121722427788796116970871747948797908408391696633288558131452593111081393198358147173946572123370132027080543190921617659835053232401230156771760600915712329437570568522075361583888185875498960189573344364967733768333163943604965647908899301265317317413012441934169916494206894449324835255191582952628599699785432186758739774421332129033903788784045423259533051135417824750257586596141541628803159805798706604473108998714377552419597551193846684457861657118233974990129030224473988640292887883378165213421725876945696204064405241557758891780719721890582967473442162503402773469986180422835277882936369581662492027715395290930955248360141712348640975388961574587181982962522642342639383424418515600772700394129921259402256152096929023653529141603812941608738998962930368317556485700472860732942061433763877981336550636475897090618550249579458974034651893308793874100615601196873448921563516017106953328624648152649328922743375401318967852367742959333548546346392900331073746509994796067091233049766977629494570632997201\n public exponent: 65537\n Validity: [From: Mon Dec 02 20:57:57 UTC 2013,\n To: Wed Dec 02 20:55:03 UTC 2043]\n Issuer: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n SerialNumber: [ 01]\n\nCertificate Extensions: 3\n[1]: ObjectId: 2.5.29.19 Criticality=true\nBasicConstraints:[\n CA:true\n PathLen:2147483647\n]\n\n[2]: ObjectId: 2.5.29.15 Criticality=true\nKeyUsage [\n DigitalSignature\n Non_repudiation\n Key_CertSign\n Crl_Sign\n]\n\n[3]: ObjectId: 2.5.29.14 Criticality=false\nSubjectKeyIdentifier [\nKeyIdentifier [\n0000: E4 2F 5C D4 E3 2C 07 EF CC 3B 09 7D 38 A1 B6 0F ./\..,...;..8...\n0010: F5 D2 C2 B5 ....\n]\n]\n\n]\n Algorithm: [SHA256withRSA]\n Signature:\n0000: 65 0B 60 4F D5 AE 70 37 2B 4A 6D 80 7A D6 95 0A e.`O..p7+Jm.z...\n0010: 0F 7E 9E 70 1A F4 9C 82 C9 B2 D3 0A 7D A8 4D DB ...p..........M.\n0020: EA 7F F8 6C B7 A1 04 A6 F9 C3 86 37 25 50 3D 82 ...l.......7%P=.\n0030: 3C 68 43 9C 44 DA CB 03 B5 42 D9 DE 72 A7 19 69 <hC.D....B..r..i\n0040: 8C 37 7A 8E 06 84 59 08 0E 8A 8C AB 35 F3 AD 29 .7z...Y.....5..)\n0050: D3 DB 66 D5 27 14 B1 A8 C3 27 5E 53 A7 59 C8 CD ..f.'....'^S.Y..\n0060: F4 74 A0 FE B7 FB 66 C9 C7 E2 57 33 C7 CF 28 E2 .t....f...W3..(.\n0070: 5E DB 8E 61 8F 6A EC D5 CD C9 5E C1 82 7B E5 15 ^..a.j....^.....\n0080: AE 51 AC A2 D1 BE C1 1D 0F 76 B7 A3 69 72 7C 1D .Q.......v..ir..\n0090: B8 41 40 77 1B 86 08 EC 0F 51 9B E8 48 26 E1 8C [email protected]&..\n00A0: 51 28 0B 5C 55 8D EA F4 42 8A 58 01 A1 6C 2D 6A Q(.\U...B.X..l-j\n00B0: BC 28 75 88 B3 4A A3 71 5E 1A 09 B6 AF 71 06 2F .(u..J.q^....q./\n00C0: 87 18 24 16 F6 7E 14 8A 96 D8 C8 4A A0 83 85 8A ..$........J....\n00D0: B8 B6 99 4E 21 E4 12 24 9C 89 0B C8 1F 5B F0 67 ...N!..$.....[.g\n00E0: 31 4D FD 95 38 CD 82 74 A3 8C 63 CB 41 71 95 F9 1M..8..t..c.Aq..\n00F0: 49 5B FC 28 0D 30 9D D1 85 12 5D 06 82 DC A4 89 I[.(.0....].....\n0100: BF 11 E2 F1 E8 92 EA FF 61 2B C7 2E C2 C6 36 92 ........a+....6.\n0110: 39 C0 F4 50 A6 B5 E3 E7 73 2D 21 D5 B1 77 ED 1D 9..P....s-!..w..\n0120: 9B 8E CB 9E 3C 5F C9 B5 F0 AA EE 49 9B 1F E6 E0 ....<_.....I....\n0130: 13 DD CE CD AA 55 ED AF D6 20 39 55 2A 48 9C A4 .....U... 9U*H..\n0140: 34 01 D3 1A 2F C1 1C 1D 5D 0B 67 25 2A FC 4D 12 4.../...].g%*.M.\n0150: 57 CB 59 6A C6 F7 26 80 77 94 C5 5B 4F B7 C2 C6 W.Yj..&.w..[O...\n0160: 83 23 04 59 2F 9F 38 02 C1 70 C0 00 F7 28 CA 35 .#.Y/.8..p...(.5\n0170: A1 4F F6 CD 1B ED 9B 41 3E 56 08 6C B8 3F D9 20 .O.....A>V.l.?. \n0180: 4D 71 69 51 93 3D A2 FB A6 1F D8 80 2F 7E D2 B1 MqiQ.=....../...\n0190: 87 89 E6 AE 4F C4 97 CF A4 72 A7 78 74 46 D6 0C ....O....r.xtF..\n01A0: 2C 56 4E 31 32 8C EF 18 E6 71 B3 19 0F 0A CE 73 ,VN12....q.....s\n01B0: E2 7F 5E 32 BD 75 B8 82 AA 5C 79 FC 1F 0F D3 15 ..^2.u...\y.....\n01C0: 9A 61 81 F3 BC 4E 7F 7D A7 E2 3D 8C E8 1B 21 55 .a...N....=...!U\n01D0: 51 7A AE BB 47 45 08 24 2B BE 31 7F CB 4B 42 4C Qz..GE.$+.1..KBL\n01E0: F9 B8 85 08 A6 DE 4D 45 FB 93 42 85 C6 DE 36 08 ......ME..B...6.\n01F0: 0D FA 4A BE 55 D9 52 A8 F8 50 12 E3 98 FA 43 6F ..J.U.R..P....Co\n\n]\n-----END ROOT CERTIFICATE-----",
"interCertData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
"rootCertData" : "rootCertificateData"
} ]
}
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 trusted CA chain certificate",
"type" : "string"
},
"name" : {
"description" : "Name of the trusted CA chain certificate",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the trusted CA chain certificate",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"modifierUsername" : {
"description" : "Modifier user name of the trusted CA chain certificate",
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"modifiedDateTime" : {
"description" : "Modifier of the trusted CA chain certificate",
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"information" : {
"description" : "Information of the certificates",
"type" : "string"
},
"interCertData" : {
"description" : "Intermediate data of the trusted CA chain certificates",
"type" : [ "array", "null" ],
"items" : {
"type" : "string"
}
},
"rootCertData" : {
"description" : "Root data of the trusted CA chain certificates",
"type" : "string"
}
}
}
}
}
}
Retrieve Trusted CA Chain Certificates ¶
GET/v6_1/certstore/trustedCAChainCert/{id}
Use this API command to retrieve an installed trusted CA chain certificates.
200
Body
{
"id": "certificateID",
"name": "certificateName",
"description": "certificate description",
"interCertData": [
"intermediateCertifcateData1",
"intermediateCertifcateData2"
],
"rootCertData": "rootCertificateData"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the trusted CA chain certificates",
"type": "string"
},
"name": {
"description": "Name of the trusted CA chain certificates",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the trusted CA chain certificates",
"type": [
"string",
"null"
],
"maxLength": 64
},
"interCertData": {
"description": "Intermediate data of the trusted CA chain certificates",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"rootCertData": {
"description": "Root data of the trusted CA chain certificates",
"type": "string"
}
}
}
Create Trusted CA Chain Certificates ¶
POST/v6_1/certstore/trustedCAChainCert
Use this API command to create trusted CA chain certificates.
Body
{
"name": "LDAP trusted CA chain Certificates",
"description": "LDAPS trusted CA chain certificates description",
"interCertData": [
"intermediateCertifcateData1",
"intermediateCertifcateData2"
],
"rootCertData": "rootCertificateData"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the trusted CA chain certificates",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the trusted CA chain certificates",
"type": [
"string",
"null"
],
"maxLength": 64
},
"interCertData": {
"description": "Intermediate data of the trusted CA chain certificates",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"rootCertData": {
"description": "Root data of the trusted CA chain certificates",
"type": "string"
}
},
"required": [
"name",
"rootCertData"
]
}
201
Body
{
"id": "certificateUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Delete Trusted CA Chain Certificates ¶
DELETE/v6_1/certstore/trustedCAChainCert/{id}
Use this API command to delete a trusted CA chain certificate.
204
Delete bulk Trusted CA Chain Certificates ¶
DELETE/v6_1/certstore/trustedCAChainCert
Use this API command to delete bulk trusted CA chain certificates.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Patch Trusted CA Chain Certificates ¶
PATCH/v6_1/certstore/trustedCAChainCert/{id}
Use this API command to patch a trusted CA chain certificates.
Body
{
"name" : "LDAP trusted CA chain Certificates",
"description" : "LDAPS trusted CA chain certificates description",
"information" : "\n\n-----BEGIN INTERMEDIATE CERTIFICATE #1 -----\n[\n[\n Version: V3\n Subject: CN=Verizon Hotspot 2.0 Intermediate CA, OU=Cybertrust, O=Verizon Enterprise Solutions, L=Amsterdam, C=NL\n Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n Key: Sun RSA public key, 2048 bits\n modulus: 23617561117988111216066421024092057505707971583866555863467960236740199253262690005512455723125315310387461393165651970748842793301611918034442594711994634192423187372806761353350113250438225110389282744014438367665821734885051972120241834680068338044857354569175288575440030311710708015575344394358723355054477230016829047631782713506713276018655043123697918236044268053319322704458844413722254348232276124596584542075041243826757391193963245254337908100807532825175242207243382889107249881414575066011404307393987338973084479538528154253484161987803827349486330380817232385299053004582804890215693233201596774334823\n public exponent: 65537\n Validity: [From: Mon Aug 11 18:44:39 UTC 2014,\n To: Sun Aug 11 18:44:09 UTC 2024]\n Issuer: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n SerialNumber: [ cb]\n\nCertificate Extensions: 6\n[1]: ObjectId: 1.3.6.1.5.5.7.1.1 Criticality=false\nAuthorityInfoAccess [\n [\n accessMethod: ocsp\n accessLocation: URIName: http://ocsp.omniroot.com/hotspotroot\n]\n]\n\n[2]: ObjectId: 2.5.29.35 Criticality=false\nAuthorityKeyIdentifier [\nKeyIdentifier [\n0000: E4 2F 5C D4 E3 2C 07 EF CC 3B 09 7D 38 A1 B6 0F ./\..,...;..8...\n0010: F5 D2 C2 B5 ....\n]\n]\n\n[3]: ObjectId: 2.5.29.19 Criticality=true\nBasicConstraints:[\n CA:true\n PathLen:0\n]\n\n[4]: ObjectId: 2.5.29.32 Criticality=false\nCertificatePolicies [\n [CertificatePolicyId: [1.3.6.1.4.1.6334.1.600.1]\n[PolicyQualifierInfo: [\n qualifierID: 1.3.6.1.5.5.7.2.1\n qualifier: 0000: 16 27 20 68 74 74 70 73 3A 2F 2F 73 65 63 75 72 .' https://secur\n0010: 65 2E 6F 6D 6E 69 72 6F 6F 74 2E 63 6F 6D 2F 72 e.omniroot.com/r\n0020: 65 70 6F 73 69 74 6F 72 79 epository\n\n]] ]\n]\n\n[5]: ObjectId: 2.5.29.15 Criticality=true\nKeyUsage [\n DigitalSignature\n Non_repudiation\n Key_CertSign\n Crl_Sign\n]\n\n[6]: ObjectId: 2.5.29.14 Criticality=false\nSubjectKeyIdentifier [\nKeyIdentifier [\n0000: 5C 5D 9D B6 A0 47 88 1B 61 40 E1 B7 E6 42 CE 81 \][email protected]..\n0010: 2F 44 6E 40 /Dn@\n]\n]\n\n]\n Algorithm: [SHA256withRSA]\n Signature:\n0000: 86 44 36 50 5A F2 92 22 B1 CD F1 3F 76 46 D0 F2 .D6PZ..\"...?vF..\n0010: 21 71 E8 7C CD 15 67 69 F0 0A AE 07 34 61 B4 2F !q....gi....4a./\n0020: 9A 7F E1 70 5C 87 BA F5 62 6C D9 C9 C9 4D 38 15 ...p\...bl...M8.\n0030: C2 9A 3F 1A 9E 94 A3 2E EB 77 76 D7 46 75 0F EC ..?......wv.Fu..\n0040: C5 CF 38 EB 52 4E FC 3D 65 05 45 40 8B 17 12 87 ..8.RN.=e.E@....\n0050: FE E3 CB 47 46 2F DC 22 00 9D C6 20 05 53 11 0A ...GF/.\"... .S..\n0060: 4B 1B 01 4C 39 2F DA 4B 4F FF 65 06 39 36 05 82 K..L9/.KO.e.96..\n0070: 81 6F 9E E5 FB 9B AF 81 91 75 63 AF EC BA 7E D8 .o.......uc.....\n0080: 99 D2 B1 FA E6 34 68 DD 03 6F 9A FE FA F8 E7 12 .....4h..o......\n0090: D0 7E A8 34 2B 2F E2 A6 9D A9 84 38 4D 8F 58 14 ...4+/.....8M.X.\n00A0: FD A3 02 04 E9 81 74 BD E6 14 F7 69 32 E9 CF 17 ......t....i2...\n00B0: 7A 45 C7 0F F8 22 A8 7E A5 8A 26 8F 3B 06 45 86 zE...\"....&.;.E.\n00C0: 09 E8 D6 AB 35 E8 C1 E2 EC F2 A0 B6 8F 39 70 D8 ....5........9p.\n00D0: AF 71 80 2C E7 45 DE 6A 78 5A 98 B7 72 CD 73 B8 .q.,.E.jxZ..r.s.\n00E0: 33 4F 56 C7 95 58 13 B4 23 8D CC F1 BC 72 2A ED 3OV..X..#....r*.\n00F0: 70 20 CD 5F DD 47 99 BD E0 46 8E E2 37 86 0B F9 p ._.G...F..7...\n0100: 47 A4 5A EC F5 A4 93 C7 F4 C3 44 86 FA 00 C5 D1 G.Z.......D.....\n0110: FA C3 D8 72 1E 1E 66 3B 9E 44 51 0C 5B 41 29 AF ...r..f;.DQ.[A).\n0120: A1 73 9B 4E 27 BF 91 22 97 C6 B1 EC E8 48 A5 F5 .s.N'..\".....H..\n0130: EF 52 21 58 57 6B A3 4F 03 F8 D8 85 F4 8C 9F 8E .R!XWk.O........\n0140: 63 B4 15 D5 A4 AE 55 48 20 66 29 91 51 66 2A C2 c.....UH f).Qf*.\n0150: 37 64 2A F5 1B FC B0 9A 99 48 95 6E EF 20 50 D5 7d*......H.n. P.\n0160: E3 E6 22 BB 6F 99 11 5A A9 79 7E 56 EC B9 6A 54 ..\".o..Z.y.V..jT\n0170: C3 51 C2 1D 42 C1 90 1C 02 D0 21 2D AF 91 D4 31 .Q..B.....!-...1\n0180: 87 FA 62 4E 85 DF 2B 66 57 C4 B9 33 96 92 AA 44 ..bN..+fW..3...D\n0190: EC 8D 92 86 0B 7B AB DE D0 DC 3D E2 70 68 AD 68 ..........=.ph.h\n01A0: 84 E8 AC 51 2A D0 9B E4 D8 E8 EB FE F5 FC 0E 24 ...Q*..........$\n01B0: 49 2C F1 A7 4E CE B2 A7 13 20 35 E6 C7 E5 FA D2 I,..N.... 5.....\n01C0: D4 45 7B 02 60 3E CD E9 A6 DB B1 5A 61 B7 D2 E2 .E..`>.....Za...\n01D0: 5F A5 7E 68 14 39 9A 8D 2A 05 5A 73 EF E2 74 BE _..h.9..*.Zs..t.\n01E0: F2 7B D4 42 0D 83 32 78 43 EC 7E 9B C2 4D FD 8A ...B..2xC....M..\n01F0: 3A 5B 2B 2F 11 DC 3D 30 EC F5 E5 7D 07 BD F2 FF :[+/..=0........\n\n]\n-----END INTERMEDIATE CERTIFICATE #1 -----\n\n\n-----BEGIN ROOT CERTIFICATE-----\n[\n[\n Version: V3\n Subject: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n Key: Sun RSA public key, 4096 bits\n modulus: 792638386379776963560612627326855893912470807469865669361657331704603816803537228716538884420089923713620126175365944334916415693271509111815409260473015474112479914130474130953326558757576918270442304172218244844002121722427788796116970871747948797908408391696633288558131452593111081393198358147173946572123370132027080543190921617659835053232401230156771760600915712329437570568522075361583888185875498960189573344364967733768333163943604965647908899301265317317413012441934169916494206894449324835255191582952628599699785432186758739774421332129033903788784045423259533051135417824750257586596141541628803159805798706604473108998714377552419597551193846684457861657118233974990129030224473988640292887883378165213421725876945696204064405241557758891780719721890582967473442162503402773469986180422835277882936369581662492027715395290930955248360141712348640975388961574587181982962522642342639383424418515600772700394129921259402256152096929023653529141603812941608738998962930368317556485700472860732942061433763877981336550636475897090618550249579458974034651893308793874100615601196873448921563516017106953328624648152649328922743375401318967852367742959333548546346392900331073746509994796067091233049766977629494570632997201\n public exponent: 65537\n Validity: [From: Mon Dec 02 20:57:57 UTC 2013,\n To: Wed Dec 02 20:55:03 UTC 2043]\n Issuer: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n SerialNumber: [ 01]\n\nCertificate Extensions: 3\n[1]: ObjectId: 2.5.29.19 Criticality=true\nBasicConstraints:[\n CA:true\n PathLen:2147483647\n]\n\n[2]: ObjectId: 2.5.29.15 Criticality=true\nKeyUsage [\n DigitalSignature\n Non_repudiation\n Key_CertSign\n Crl_Sign\n]\n\n[3]: ObjectId: 2.5.29.14 Criticality=false\nSubjectKeyIdentifier [\nKeyIdentifier [\n0000: E4 2F 5C D4 E3 2C 07 EF CC 3B 09 7D 38 A1 B6 0F ./\..,...;..8...\n0010: F5 D2 C2 B5 ....\n]\n]\n\n]\n Algorithm: [SHA256withRSA]\n Signature:\n0000: 65 0B 60 4F D5 AE 70 37 2B 4A 6D 80 7A D6 95 0A e.`O..p7+Jm.z...\n0010: 0F 7E 9E 70 1A F4 9C 82 C9 B2 D3 0A 7D A8 4D DB ...p..........M.\n0020: EA 7F F8 6C B7 A1 04 A6 F9 C3 86 37 25 50 3D 82 ...l.......7%P=.\n0030: 3C 68 43 9C 44 DA CB 03 B5 42 D9 DE 72 A7 19 69 <hC.D....B..r..i\n0040: 8C 37 7A 8E 06 84 59 08 0E 8A 8C AB 35 F3 AD 29 .7z...Y.....5..)\n0050: D3 DB 66 D5 27 14 B1 A8 C3 27 5E 53 A7 59 C8 CD ..f.'....'^S.Y..\n0060: F4 74 A0 FE B7 FB 66 C9 C7 E2 57 33 C7 CF 28 E2 .t....f...W3..(.\n0070: 5E DB 8E 61 8F 6A EC D5 CD C9 5E C1 82 7B E5 15 ^..a.j....^.....\n0080: AE 51 AC A2 D1 BE C1 1D 0F 76 B7 A3 69 72 7C 1D .Q.......v..ir..\n0090: B8 41 40 77 1B 86 08 EC 0F 51 9B E8 48 26 E1 8C [email protected]&..\n00A0: 51 28 0B 5C 55 8D EA F4 42 8A 58 01 A1 6C 2D 6A Q(.\U...B.X..l-j\n00B0: BC 28 75 88 B3 4A A3 71 5E 1A 09 B6 AF 71 06 2F .(u..J.q^....q./\n00C0: 87 18 24 16 F6 7E 14 8A 96 D8 C8 4A A0 83 85 8A ..$........J....\n00D0: B8 B6 99 4E 21 E4 12 24 9C 89 0B C8 1F 5B F0 67 ...N!..$.....[.g\n00E0: 31 4D FD 95 38 CD 82 74 A3 8C 63 CB 41 71 95 F9 1M..8..t..c.Aq..\n00F0: 49 5B FC 28 0D 30 9D D1 85 12 5D 06 82 DC A4 89 I[.(.0....].....\n0100: BF 11 E2 F1 E8 92 EA FF 61 2B C7 2E C2 C6 36 92 ........a+....6.\n0110: 39 C0 F4 50 A6 B5 E3 E7 73 2D 21 D5 B1 77 ED 1D 9..P....s-!..w..\n0120: 9B 8E CB 9E 3C 5F C9 B5 F0 AA EE 49 9B 1F E6 E0 ....<_.....I....\n0130: 13 DD CE CD AA 55 ED AF D6 20 39 55 2A 48 9C A4 .....U... 9U*H..\n0140: 34 01 D3 1A 2F C1 1C 1D 5D 0B 67 25 2A FC 4D 12 4.../...].g%*.M.\n0150: 57 CB 59 6A C6 F7 26 80 77 94 C5 5B 4F B7 C2 C6 W.Yj..&.w..[O...\n0160: 83 23 04 59 2F 9F 38 02 C1 70 C0 00 F7 28 CA 35 .#.Y/.8..p...(.5\n0170: A1 4F F6 CD 1B ED 9B 41 3E 56 08 6C B8 3F D9 20 .O.....A>V.l.?. \n0180: 4D 71 69 51 93 3D A2 FB A6 1F D8 80 2F 7E D2 B1 MqiQ.=....../...\n0190: 87 89 E6 AE 4F C4 97 CF A4 72 A7 78 74 46 D6 0C ....O....r.xtF..\n01A0: 2C 56 4E 31 32 8C EF 18 E6 71 B3 19 0F 0A CE 73 ,VN12....q.....s\n01B0: E2 7F 5E 32 BD 75 B8 82 AA 5C 79 FC 1F 0F D3 15 ..^2.u...\y.....\n01C0: 9A 61 81 F3 BC 4E 7F 7D A7 E2 3D 8C E8 1B 21 55 .a...N....=...!U\n01D0: 51 7A AE BB 47 45 08 24 2B BE 31 7F CB 4B 42 4C Qz..GE.$+.1..KBL\n01E0: F9 B8 85 08 A6 DE 4D 45 FB 93 42 85 C6 DE 36 08 ......ME..B...6.\n01F0: 0D FA 4A BE 55 D9 52 A8 F8 50 12 E3 98 FA 43 6F ..J.U.R..P....Co\n\n]\n-----END ROOT CERTIFICATE-----",
"interCertData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
"rootCertData" : "rootCertificateData"
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the trusted CA chain certificates",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the trusted CA chain certificates",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"information" : {
"description" : "Information of the certificates",
"type" : "string"
},
"interCertData" : {
"description" : "Intermediate data of the trusted CA chain certificates",
"type" : [ "array", "null" ],
"items" : {
"type" : "string"
}
},
"rootCertData" : {
"description" : "Root data of the trusted CA chain certificates",
"type" : "string"
}
}
}
204
Application Visibility Control ¶
User Defined Retrieve List ¶
POST/v6_1/query/userDefined
Use this API command to retrieve a list of AVC User Defined profiles. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"name": "ip-and-port",
"type": "IP_WITH_PORT",
"id": "acc29c30-ee35-11e4-8c03-000c292547b9",
"appId": 1,
"domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
"destIp": "11.22.33.44",
"netmask": "255.255.255.0",
"destPort": 22,
"protocol": "TCP"
},
{
"name": "port-only",
"type": "PORT_ONLY",
"id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
"appId": 1,
"domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
"destPort": 99,
"protocol": "UDP"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "Extra information for user defined policy",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the User Defined Profile",
"type": "string"
},
"appId": {
"description": "AppId for Application Policy's User defined rule type",
"type": "integer"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the User Defined Profile belongs",
"type": "string"
},
"name": {
"description": "Name of the User Defined Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"type": {
"description": "Type of the User Defined Profile",
"enum": [
"IP_WITH_PORT",
"PORT_ONLY"
]
},
"destIp": {
"description": "Destination Server IP",
"type": "string"
},
"netmask": {
"description": "Netmask of User Defined Profile",
"type": "string",
"pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"destPort": {
"description": "Destination Port of User Defined Profile",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"description": "Protocol of User Defined Profile",
"enum": [
"TCP",
"UDP"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
User Defined Retrieve ¶
GET/v6_1/avc/userDefined/{id}
Use this API command to retrieve a AVC User Defined profile.
200
Body
{
"name": "test-modify",
"type": "IP_WITH_PORT",
"id": "acc29c30-ee35-11e4-8c03-000c292547b9",
"appId": 1,
"destIp": "11.22.33.44",
"netmask": "255.255.255.0",
"destPort": 22,
"protocol": "TCP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the User Defined Profile",
"type": "string"
},
"appId": {
"description": "AppId for Application Policy's User defined rule type",
"type": "integer"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the User Defined Profile belongs",
"type": "string"
},
"name": {
"description": "Name of the User Defined Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"type": {
"description": "Type of the User Defined Profile",
"enum": [
"IP_WITH_PORT",
"PORT_ONLY"
]
},
"destIp": {
"description": "Destination Server IP",
"type": "string"
},
"netmask": {
"description": "Netmask of User Defined Profile",
"type": "string",
"pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"destPort": {
"description": "Destination Port of User Defined Profile",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"description": "Protocol of User Defined Profile",
"enum": [
"TCP",
"UDP"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
User Defined Create ¶
POST/v6_1/avc/userDefined
Use this API command to create a new AVC User Defined profile.
Body
{
"name": "postman-c",
"type": "IP_WITH_PORT",
"destIp": "11.22.33.44",
"netmask": "255.255.255.0",
"destPort": 22,
"protocol": "TCP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the User Defined Profile belongs",
"type": "string"
},
"name": {
"description": "Name of the User Defined Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"type": {
"description": "Type of the User Defined Profile",
"enum": [
"IP_WITH_PORT",
"PORT_ONLY"
]
},
"destIp": {
"description": "Destination Server IP",
"type": "string"
},
"netmask": {
"description": "Netmask of User Defined Profile",
"type": "string",
"pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"destPort": {
"description": "Destination Port of User Defined Profile",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"description": "Protocol of User Defined Profile",
"enum": [
"TCP",
"UDP"
]
}
},
"required": [
"name",
"type",
"destPort",
"protocol"
]
}
201
Body
{
"id": "acc29c30-ee35-11e4-8c03-000c292547b9"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
User Defined Modify ¶
PATCH/v6_1/avc/userDefined/{id}
Use this API command to modify the basic information on AVC User Defined profile.
Body
{
"name": "test-modify",
"destIp": "11.22.33.44",
"netmask": "255.255.255.0",
"destPort": 11,
"protocol": "UDP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the User Defined Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"type": {
"description": "Type of the User Defined Profile",
"enum": [
"IP_WITH_PORT",
"PORT_ONLY"
]
},
"destIp": {
"description": "Destination Server IP",
"type": "string"
},
"netmask": {
"description": "Netmask of User Defined Profile",
"type": "string",
"pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"destPort": {
"description": "Destination Port of User Defined Profile",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"description": "Protocol of User Defined Profile",
"enum": [
"TCP",
"UDP"
]
}
}
}
204
User Defined Delete ¶
DELETE/v6_1/avc/userDefined/{id}
Use this API command to delete a AVC User Defined Profile.
204
User Defined Multiple Delete ¶
DELETE/v6_1/avc/userDefined
Use this API command to delete a AVC User Defined Profile.
Body
{
"idList": [
"acc29c30-ee35-11e4-8c03-000c292547b9",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Application Policy Retrieve List ¶
POST/v6_1/query/applicationPolicy
Use this API command to retrieve a list of AVC Application Policy profiles. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"name": "postman-dp-c",
"id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
"description": "postman-dp-c",
"domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
"applicationRules": [
{
"ruleType": "DENY",
"applicationType": "SIGNATURE",
"catId": "126",
"appId": "1"
}
],
"avcLogEnable": false,
"avcEventEnable": false
},
{
"name": "test2",
"id": "0a782052-96d5-738b-afce-aa8157abd30c",
"description": "test-2",
"domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
"applicationRules": [
{
"ruleType": "QOS",
"applicationType": "SIGNATURE",
"catId": "126",
"appId": "1",
"markingPriority": "DSCP",
"markingType": "VOICE",
"classificationType": "VOICE"
}
],
"avcLogEnable": false,
"avcEventEnable": false
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "Extra information for application policy",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Application Policy Profile",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
"type": "string"
},
"name": {
"description": "Name of the Application Policy Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Application Policy Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"applicationRules": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer"
},
"ruleType": {
"description": "Type of the application rule",
"enum": [
"DENY",
"QOS",
"RATE_LIMITING"
]
},
"applicationType": {
"description": "Type of the application when ruleType",
"enum": [
"SIGNATURE",
"USER_DEFINED"
]
},
"catId": {
"description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
"type": "string"
},
"catName": {
"description": "Name of the Application Category from Signature Package",
"type": "string"
},
"appId": {
"description": "Identifier of the Application from Signature Package",
"type": "string"
},
"appName": {
"description": "Name of the Application from Signature Package",
"type": "string"
},
"uplink": {
"description": "Uplink rate limiting (unit: Kbps)",
"type": "integer"
},
"downlink": {
"description": "Downlink rate limiting (unit: Kbps)",
"type": "integer"
},
"markingPriority": {
"description": "QoS uplink marking priority",
"enum": [
"IEEE802_1p",
"DSCP",
"BOTH"
]
},
"markingType": {
"description": "QoS uplink marking type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
},
"classificationType": {
"description": "QoS downlink classification type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
}
}
}
},
"avcLogEnable": {
"description": "Send ARC logs from AP to external syslog server",
"type": "boolean"
},
"avcEventEnable": {
"description": "Send ARC logs from AP to SmartZone",
"type": "boolean"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Application Policy Retrieve ¶
GET/v6_1/avc/applicationPolicy/{id}
Use this API command to retrieve a AVC Application Policy profile.
200
Body
{
"name": "postman-dp-c",
"id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
"description": "postman-dp-c",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"applicationRules": [
{
"ruleType": "DENY",
"applicationType": "SIGNATURE",
"catId": "126",
"appId": "1"
}
],
"avcLogEnable": false,
"avcEventEnable": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Application Policy Profile",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
"type": "string"
},
"name": {
"description": "Name of the Application Policy Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Application Policy Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"applicationRules": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer"
},
"ruleType": {
"description": "Type of the application rule",
"enum": [
"DENY",
"QOS",
"RATE_LIMITING"
]
},
"applicationType": {
"description": "Type of the application when ruleType",
"enum": [
"SIGNATURE",
"USER_DEFINED"
]
},
"catId": {
"description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
"type": "string"
},
"catName": {
"description": "Name of the Application Category from Signature Package",
"type": "string"
},
"appId": {
"description": "Identifier of the Application from Signature Package",
"type": "string"
},
"appName": {
"description": "Name of the Application from Signature Package",
"type": "string"
},
"uplink": {
"description": "Uplink rate limiting (unit: Kbps)",
"type": "integer"
},
"downlink": {
"description": "Downlink rate limiting (unit: Kbps)",
"type": "integer"
},
"markingPriority": {
"description": "QoS uplink marking priority",
"enum": [
"IEEE802_1p",
"DSCP",
"BOTH"
]
},
"markingType": {
"description": "QoS uplink marking type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
},
"classificationType": {
"description": "QoS downlink classification type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
}
}
}
},
"avcLogEnable": {
"description": "Send ARC logs from AP to external syslog server",
"type": "boolean"
},
"avcEventEnable": {
"description": "Send ARC logs from AP to SmartZone",
"type": "boolean"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Application Policy Create ¶
POST/v6_1/avc/applicationPolicy
Use this API command to create a new AVC Application Policy profile.
Body
{
"name": "aa",
"description": "",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"applicationRules": [
{
"ruleType": "DENY",
"applicationType": "USER_DEFINED",
"catId": "32768",
"appId": "2",
"priority": 1
},
{
"ruleType": "DENY",
"applicationType": "SIGNATURE",
"catId": "128",
"appId": "1",
"priority": 2
},
{
"ruleType": "QOS",
"applicationType": "SIGNATURE",
"catId": "168",
"appId": "2",
"markingPriority": "IEEE802_1p",
"markingType": "VOICE",
"classificationType": "VOICE",
"priority": 3
},
{
"ruleType": "RATE_LIMITING",
"applicationType": "SIGNATURE",
"catId": "168",
"appId": "3",
"uplink": 1000,
"downlink": 2000,
"priority": 4
}
],
"avcLogEnable": false,
"avcEventEnable": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
"type": "string"
},
"name": {
"description": "Name of the Application Policy Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Application Policy Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"applicationRules": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer"
},
"ruleType": {
"description": "Type of the application rule",
"enum": [
"DENY",
"QOS",
"RATE_LIMITING"
]
},
"applicationType": {
"description": "Type of the application when ruleType",
"enum": [
"SIGNATURE",
"USER_DEFINED"
]
},
"catId": {
"description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
"type": "string"
},
"catName": {
"description": "Name of the Application Category from Signature Package",
"type": "string"
},
"appId": {
"description": "Identifier of the Application from Signature Package",
"type": "string"
},
"appName": {
"description": "Name of the Application from Signature Package",
"type": "string"
},
"uplink": {
"description": "Uplink rate limiting (unit: Kbps)",
"type": "integer"
},
"downlink": {
"description": "Downlink rate limiting (unit: Kbps)",
"type": "integer"
},
"markingPriority": {
"description": "QoS uplink marking priority",
"enum": [
"IEEE802_1p",
"DSCP",
"BOTH"
]
},
"markingType": {
"description": "QoS uplink marking type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
},
"classificationType": {
"description": "QoS downlink classification type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
}
}
}
},
"avcLogEnable": {
"description": "Send ARC logs from AP to external syslog server",
"type": "boolean"
},
"avcEventEnable": {
"description": "Send ARC logs from AP to SmartZone",
"type": "boolean"
}
},
"required": [
"name",
"applicationRules"
]
}
201
Body
{
"id": "acc29c30-ee35-11e4-8c03-000c292547b9"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Application Policy Modify ¶
PATCH/v6_1/avc/applicationPolicy/{id}
Use this API command to modify the basic information on AVC Application Policy profile.
Body
{
"name": "aa",
"description": "",
"applicationRules": [
{
"priority": 1,
"ruleType": "QOS",
"applicationType": "SIGNATURE",
"catId": "128",
"appId": "2",
"markingPriority": "IEEE802_1p",
"markingType": "VOICE",
"classificationType": "VOICE"
},
{
"priority": 2,
"ruleType": "DENY",
"applicationType": "USER_DEFINED",
"catId": "32768",
"appId": "2"
},
{
"priority": 3,
"ruleType": "DENY",
"applicationType": "SIGNATURE",
"catId": "128",
"appId": "1"
}
],
"avcLogEnable": false,
"avcEventEnable": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Application Policy Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Application Policy Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"applicationRules": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer"
},
"ruleType": {
"description": "Type of the application rule",
"enum": [
"DENY",
"QOS",
"RATE_LIMITING"
]
},
"applicationType": {
"description": "Type of the application when ruleType",
"enum": [
"SIGNATURE",
"USER_DEFINED"
]
},
"catId": {
"description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
"type": "string"
},
"catName": {
"description": "Name of the Application Category from Signature Package",
"type": "string"
},
"appId": {
"description": "Identifier of the Application from Signature Package",
"type": "string"
},
"appName": {
"description": "Name of the Application from Signature Package",
"type": "string"
},
"uplink": {
"description": "Uplink rate limiting (unit: Kbps)",
"type": "integer"
},
"downlink": {
"description": "Downlink rate limiting (unit: Kbps)",
"type": "integer"
},
"markingPriority": {
"description": "QoS uplink marking priority",
"enum": [
"IEEE802_1p",
"DSCP",
"BOTH"
]
},
"markingType": {
"description": "QoS uplink marking type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
},
"classificationType": {
"description": "QoS downlink classification type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
}
}
}
},
"avcLogEnable": {
"description": "Send ARC logs from AP to external syslog server",
"type": "boolean"
},
"avcEventEnable": {
"description": "Send ARC logs from AP to SmartZone",
"type": "boolean"
}
}
}
204
Application Policy Modify applicationRules ¶
PATCH/v6_1/avc/applicationPolicy/{id}/applicationRules
Use this API command to modify the applicationRules information on AVC Application Policy profile.
Body
[
{
"priority": 1,
"ruleType": "QOS",
"applicationType": "SIGNATURE",
"catId": "128",
"appId": "2",
"markingPriority": "IEEE802_1p",
"markingType": "VOICE",
"classificationType": "VOICE"
},
{
"priority": 2,
"ruleType": "DENY",
"applicationType": "USER_DEFINED",
"catId": "32768",
"appId": "2"
},
{
"priority": 3,
"ruleType": "DENY",
"applicationType": "SIGNATURE",
"catId": "128",
"appId": "1"
}
]
Schema
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer"
},
"ruleType": {
"description": "Type of the application rule",
"enum": [
"DENY",
"QOS",
"RATE_LIMITING"
]
},
"applicationType": {
"description": "Type of the application when ruleType",
"enum": [
"SIGNATURE",
"USER_DEFINED"
]
},
"catId": {
"description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
"type": "string"
},
"catName": {
"description": "Name of the Application Category from Signature Package",
"type": "string"
},
"appId": {
"description": "Identifier of the Application from Signature Package",
"type": "string"
},
"appName": {
"description": "Name of the Application from Signature Package",
"type": "string"
},
"uplink": {
"description": "Uplink rate limiting (unit: Kbps)",
"type": "integer"
},
"downlink": {
"description": "Downlink rate limiting (unit: Kbps)",
"type": "integer"
},
"markingPriority": {
"description": "QoS uplink marking priority",
"enum": [
"IEEE802_1p",
"DSCP",
"BOTH"
]
},
"markingType": {
"description": "QoS uplink marking type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
},
"classificationType": {
"description": "QoS downlink classification type",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
}
}
}
}
204
Application Policy Delete ¶
DELETE/v6_1/avc/applicationPolicy/{id}
Use this API command to delete a AVC Application Policy Profile.
204
Application Policy Multiple Delete ¶
DELETE/v6_1/avc/applicationPolicy
Use this API command to delete a AVC Application Policy Profile.
Body
{
"idList": [
"acc29c30-ee35-11e4-8c03-000c292547b9",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
200
Upload File ¶
POST/v6_1/avc/signaturePackage/upload
Update AVC Signature Package by upload file.
200
Body
{
"id": "acc29c30-ee35-11e4-8c03-000c292547b9",
"fileName": "RuckusSigPack-1.005",
"size": "629145",
"version": "1.5"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Signature Package",
"type": "String"
},
"fileName": {
"description": "Name of the Signature Package",
"type": "String"
},
"version": {
"description": "Version of the Signature Package",
"type": "string"
},
"size": {
"description": "Size of the Signature Package",
"type": "integer"
}
}
}
Current Signature Package Info ¶
GET/v6_1/avc/signaturePackage
Get current Signature Package info.
200
Body
{
"id": "acc29c30-ee35-11e4-8c03-000c292547b9",
"fileName": "RuckusSigPack-1.005",
"size": "629145",
"version": "1.5"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Signature Package",
"type": "String"
},
"fileName": {
"description": "Name of the Signature Package",
"type": "String"
},
"version": {
"description": "Version of the Signature Package",
"type": "string"
},
"size": {
"description": "Size of the Signature Package",
"type": "integer"
}
}
}
Application Categories ¶
GET/v6_1/avc/signaturePackage/categories
Get Application Category list from current Signature Package.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "128",
"name": "Instant messaging"
},
{
"id": "129",
"name": "P2P"
}
]
}
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 Application Category",
"type": "String"
},
"name": {
"description": "Name of the Application Category",
"type": "String"
}
}
}
}
}
}
Applications ¶
GET/v6_1/avc/signaturePackage/applications
Get Application list from current Signature Package.
200
Body
{
"totalCount": 5,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"catId": "128",
"appId": "1",
"name": "MSN"
},
{
"catId": "128",
"appId": "2",
"name": "Yahoo Messenger"
},
{
"catId": "128",
"appId": "3",
"name": "AIM/ICQ/iIM"
},
{
"catId": "129",
"appId": "2",
"name": "BitTorrent Series"
},
{
"catId": "129",
"appId": "4",
"name": "DirectConnect"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"catId": {
"description": "Identifier of the Application Category",
"type": "String"
},
"appId": {
"description": "Identifier of the Application",
"type": "String"
},
"name": {
"description": "Name of the Application",
"type": "String"
}
}
}
}
}
}
Application Category ¶
GET/v6_1/avc/signaturePackage/category/{categoryName}
Get Application Category info (catId and name) by category name.
200
Body
{
"id": "128",
"name": "Instant messaging"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Application Category",
"type": "String"
},
"name": {
"description": "Name of the Application Category",
"type": "String"
}
}
}
Application ¶
GET/v6_1/avc/signaturePackage/application/{applicationName}
Get Application info (catId, appId and name) by application name.
200
Body
{
"catId": "128",
"appId": "1",
"name": "MSN"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"catId": {
"description": "Identifier of the Application Category",
"type": "String"
},
"appId": {
"description": "Identifier of the Application",
"type": "String"
},
"name": {
"description": "Name of the Application",
"type": "String"
}
}
}
URL Filtering Policy ¶
Retrieve URL Filtering policy List ¶
GET/v6_1/urlFiltering/urlFilteringPolicy
Use this API command to retrieve list of URL Filtering policies.
- 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)
200
Body
{
"extra": null,
"firstIndex": 0,
"hasMore": false,
"list": [
{
"blacklist": [],
"blockCategories": [
48,
10,
70,
36
],
"description": "Created from PublicAPI directly.",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
"id": "f32246c0-5013-11e7-b6be-525400a0e6c5",
"name": "test00001",
"safeSearchBingDns": null,
"safeSearchBingEnabled": false,
"safeSearchEnabled": true,
"safeSearchGoogleDns": null,
"safeSearchGoogleEnabled": true,
"safeSearchYouTubeDns": null,
"safeSearchYouTubeEnabled": false,
"whiteList": [
"172.17.99.91"
]
},
{
"blacklist": [
"www.facebook.com"
],
"blockCategories": [
48,
10,
70
],
"description": "Created from PublicAPI directly.",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
"id": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
"name": "test00002",
"safeSearchBingDns": null,
"safeSearchBingEnabled": false,
"safeSearchEnabled": true,
"safeSearchGoogleDns": "8.8.8.8",
"safeSearchGoogleEnabled": true,
"safeSearchYouTubeDns": null,
"safeSearchYouTubeEnabled": false,
"whiteList": []
}
],
"totalCount": 2
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for URL Filtering policy",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the URL Filtering policy",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the URL filtering policy belongs",
"type": "string"
},
"name": {
"description": "Name of the URL Filtering policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the URL Filtering policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"filteringLevel": {
"description": "The filtering level of the URL Filtering policy",
"enum": [
"NO_ADULT",
"CLEAN_AND_SAFE",
"CHILD_AND_STUDENT_FRIENDLY",
"STRICT",
"CUSTOM"
]
},
"blockCategories": {
"description": "The block category IDs of the URL Filtering policy",
"type": "array",
"items": {
"type": "integer"
}
},
"safeSearchGoogleEnabled": {
"description": "Enable Google safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchGoogleDns": {
"description": "Google DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchYouTubeEnabled": {
"description": "Enable YouTube safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchYouTubeDns": {
"description": "YouTube DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchBingEnabled": {
"description": "Enable Bing safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchBingDns": {
"description": "Bing DNS for safe search of the URL Filtering policy",
"type": "string"
},
"whitelist": {
"description": "The whitelist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
},
"blacklist": {
"description": "The blacklist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve URL Filtering policy ¶
GET/v6_1/urlFiltering/urlFilteringPolicy/{id}
Use this API command to retrieve an URL Filtering policy.
200
Body
{
"blacklist": [
"www.facebook.com"
],
"blockCategories": [
48,
10,
70
],
"createDateTime": 1497344072091,
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"creatorUsername": "admin",
"description": "Created from PublicAPI directly.",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
"id": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
"modifiedDateTime": 1497344072091,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"name": "test00002",
"safeSearchBingDns": null,
"safeSearchBingEnabled": false,
"safeSearchEnabled": true,
"safeSearchGoogleDns": "8.8.8.8",
"safeSearchGoogleEnabled": true,
"safeSearchYouTubeDns": null,
"safeSearchYouTubeEnabled": false,
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"whitelist": []
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the URL Filtering policy",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the URL filtering policy belongs",
"type": "string"
},
"name": {
"description": "Name of the URL Filtering policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the URL Filtering policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"filteringLevel": {
"description": "The filtering level of the URL Filtering policy",
"enum": [
"NO_ADULT",
"CLEAN_AND_SAFE",
"CHILD_AND_STUDENT_FRIENDLY",
"STRICT",
"CUSTOM"
]
},
"blockCategories": {
"description": "The block category IDs of the URL Filtering policy",
"type": "array",
"items": {
"type": "integer"
}
},
"safeSearchGoogleEnabled": {
"description": "Enable Google safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchGoogleDns": {
"description": "Google DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchYouTubeEnabled": {
"description": "Enable YouTube safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchYouTubeDns": {
"description": "YouTube DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchBingEnabled": {
"description": "Enable Bing safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchBingDns": {
"description": "Bing DNS for safe search of the URL Filtering policy",
"type": "string"
},
"whitelist": {
"description": "The whitelist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
},
"blacklist": {
"description": "The blacklist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create URL Filtering policy ¶
POST/v6_1/urlFiltering/urlFilteringPolicy
Use this API command to create a URL Filtering policy.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "test00002",
"description": "Created from PublicAPI directly.",
"filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
"blockCategories": [
48,
10,
70
],
"blacklist": [
"www.facebook.com"
],
"safeSearchEnabled": true,
"safeSearchGoogleEnabled": true,
"safeSearchGoogleDns": "8.8.8.8"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the URL filtering policy belongs",
"type": "string"
},
"name": {
"description": "Name of the URL Filtering policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the URL Filtering policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"filteringLevel": {
"description": "The filtering level of the URL Filtering policy",
"enum": [
"NO_ADULT",
"CLEAN_AND_SAFE",
"CHILD_AND_STUDENT_FRIENDLY",
"STRICT",
"CUSTOM"
]
},
"blockCategories": {
"description": "The block category IDs of the URL Filtering policy",
"type": "array",
"items": {
"type": "integer"
}
},
"safeSearchGoogleEnabled": {
"description": "Enable Google safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchGoogleDns": {
"description": "Google DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchYouTubeEnabled": {
"description": "Enable YouTube safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchYouTubeDns": {
"description": "YouTube DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchBingEnabled": {
"description": "Enable Bing safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchBingDns": {
"description": "Bing DNS for safe search of the URL Filtering policy",
"type": "string"
},
"whitelist": {
"description": "The whitelist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
},
"blacklist": {
"description": "The blacklist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
}
},
"required": [
"name",
"filteringLevel"
]
}
201
Body
{
"id": "eac50e51-4a63-11e7-a68a-0a0027000000"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Delete URL Filtering policy ¶
DELETE/v6_1/urlFiltering/urlFilteringPolicy/{id}
Use this API command to delete a URL Filtering policy.
204
Delete bulk URL Filtering policy ¶
DELETE/v6_1/urlFiltering/urlFilteringPolicy
Use this API command to delete bulk URL Filtering policies.
Body
{
"idList": [
"eac50e51-4a63-11e7-a68a-0a0027000000",
"1b4950d1-49d9-11e7-a68a-0a0027000000"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
200
Patch URL Filtering policy ¶
PATCH/v6_1/urlFiltering/urlFilteringPolicy/{id}
Use this API command to patch a URL Filtering policy.
Body
{
"name": "testURLFilteringPolicy33",
"description": "Modified from PublicAPI directly.",
"filteringLevel": "CLEAN_AND_SAFE",
"blockCategories": [
2,
8,
5,
13,
56
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the URL Filtering policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the URL Filtering policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"filteringLevel": {
"description": "The filtering level of the URL Filtering policy",
"enum": [
"NO_ADULT",
"CLEAN_AND_SAFE",
"CHILD_AND_STUDENT_FRIENDLY",
"STRICT",
"CUSTOM"
]
},
"blockCategories": {
"description": "The block category IDs of the URL Filtering policy",
"type": "array",
"items": {
"type": "integer"
}
},
"safeSearchGoogleEnabled": {
"description": "Enable Google safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchGoogleDns": {
"description": "Google DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchYouTubeEnabled": {
"description": "Enable YouTube safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchYouTubeDns": {
"description": "YouTube DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchBingEnabled": {
"description": "Enable Bing safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchBingDns": {
"description": "Bing DNS for safe search of the URL Filtering policy",
"type": "string"
},
"whitelist": {
"description": "The whitelist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
},
"blacklist": {
"description": "The blacklist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
}
}
}
204
Retrieve block categories of URL Filtering ¶
GET/v6_1/urlFiltering/blockCategories
Use this API command to retrieve the block categories of URL Filtering.
200
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 URL Filtering Category",
"type": "Integer"
},
"name": {
"description": "name of the URL Filtering Category",
"type": "string"
}
}
}
}
}
}
Retrieve URL Filtering policies List by query criteria ¶
POST/v6_1/urlFiltering/query
Use this API command to retrieve a list of URL Filtering policies by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"extra": null,
"firstIndex": 0,
"hasMore": false,
"list": [
{
"blacklist": [],
"blockCategories": [
48,
10,
70,
36
],
"description": "Created from PublicAPI directly.",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
"id": "f32246c0-5013-11e7-b6be-525400a0e6c5",
"name": "test00001",
"safeSearchBingDns": null,
"safeSearchBingEnabled": false,
"safeSearchEnabled": true,
"safeSearchGoogleDns": null,
"safeSearchGoogleEnabled": true,
"safeSearchYouTubeDns": null,
"safeSearchYouTubeEnabled": false,
"whiteList": [
"172.17.99.91"
]
},
{
"blacklist": [
"www.facebook.com"
],
"blockCategories": [
48,
10,
70
],
"description": "Created from PublicAPI directly.",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
"id": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
"name": "test00002",
"safeSearchBingDns": null,
"safeSearchBingEnabled": false,
"safeSearchEnabled": true,
"safeSearchGoogleDns": "8.8.8.8",
"safeSearchGoogleEnabled": true,
"safeSearchYouTubeDns": null,
"safeSearchYouTubeEnabled": false,
"whiteList": []
}
],
"totalCount": 2
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for URL Filtering policy",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the URL Filtering policy",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the System (root) domain or partner managed domain to which the URL filtering policy belongs",
"type": "string"
},
"name": {
"description": "Name of the URL Filtering policy",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the URL Filtering policy",
"type": [
"string",
"null"
],
"maxLength": 64
},
"filteringLevel": {
"description": "The filtering level of the URL Filtering policy",
"enum": [
"NO_ADULT",
"CLEAN_AND_SAFE",
"CHILD_AND_STUDENT_FRIENDLY",
"STRICT",
"CUSTOM"
]
},
"blockCategories": {
"description": "The block category IDs of the URL Filtering policy",
"type": "array",
"items": {
"type": "integer"
}
},
"safeSearchGoogleEnabled": {
"description": "Enable Google safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchGoogleDns": {
"description": "Google DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchYouTubeEnabled": {
"description": "Enable YouTube safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchYouTubeDns": {
"description": "YouTube DNS for safe search of the URL Filtering policy",
"type": "string"
},
"safeSearchBingEnabled": {
"description": "Enable Bing safe search of the URL Filtering policy",
"type": "boolean"
},
"safeSearchBingDns": {
"description": "Bing DNS for safe search of the URL Filtering policy",
"type": "string"
},
"whitelist": {
"description": "The whitelist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
},
"blacklist": {
"description": "The blacklist of the URL Filtering policy",
"type": "array",
"items": {
"type": "string",
"minLength": 0,
"maxLength": 64
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Ethernet Port Profile ¶
Retrieve List - Ethernet Port Porfile ¶
GET/v6_1/rkszones/{zoneId}/profile/ethernetPort
Retrieve a list of Ethernet Port Porfiles within a zone.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "0",
"name": "Default Trunk Port"
},
{
"id": "1",
"name": "Default Access Port"
}
]
}
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 service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Retrieve - Ethernet Port Porfile ¶
GET/v6_1/rkszones/{zoneId}/profile/ethernetPort/{id}
Retrieve a Ethernet Port Porfile.
200
Body
{
"name": "ethport",
"id": "13",
"description": "ethportDesc",
"type": "AccessPort",
"tunnelEnabled": true,
"untagId": 1,
"vlanMembers": "1",
"dynamicVlanEnabled": false,
"guestVlan": null,
"_8021X": {
"type": "Disable",
"authenticator": null,
"supplicant": null
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "identifier of the ethernet port profile",
"type": "string"
},
"name": {
"description": "name of the ethernet port profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the ethernet port profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"type": {
"description": "type of the ethernet port profile",
"enum": [
"AccessPort",
"TrunkPort",
"GeneralPort"
]
},
"tunnelEnabled": {
"description": "tunnelEnabled of the ethernet port profile for AccessPort type",
"type": "boolean"
},
"untagId": {
"description": "VLAN Untag ID of the ethernet port profile",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanMembers": {
"description": "VLAN Members of the ethernet port profile",
"type": "string"
},
"dynamicVlanEnabled": {
"type": "boolean"
},
"guestVlan": {
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"_8021X": {
"description": "VLAN 802.1X of the ethernet port profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"Disable",
"Supplicant",
"PortBasedAuthenticator",
"MACBasedAuthenticator"
]
},
"authenticator": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"authentication": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enableUseSCGasProxy": {
"type": "boolean"
},
"server": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"enableUseSCGasProxy"
]
},
"disabledAccounting": {
"type": "boolean"
},
"accounting": {
"desciption": "null mean Disabled",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enableUseSCGasProxy": {
"type": "boolean"
},
"server": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"enableUseSCGasProxy"
]
},
"macAuthByPassEnabled": {
"type": "boolean"
}
},
"required": [
"macAuthByPassEnabled"
]
},
"supplicant": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"MACAddress",
"Custom"
]
},
"userName": {
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
}
}
}
Create - Ethernet Port Porfile ¶
POST/v6_1/rkszones/{zoneId}/profile/ethernetPort
Create a new Ethernet Port Porfile.
Body
{
"name": "ethport",
"description": "ethportDesc",
"type": "AccessPort",
"tunnelEnabled": true,
"_8021X": {
"type": "Disable",
"authenticator": null,
"supplicant": null
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "name of the ethernet port profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the ethernet port profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"type": {
"description": "type of the ethernet port profile",
"enum": [
"AccessPort",
"TrunkPort",
"GeneralPort"
]
},
"tunnelEnabled": {
"description": "tunnelEnabled of the ethernet port profile for AccessPort type",
"type": "boolean"
},
"untagId": {
"description": "VLAN Untag ID of the ethernet port profile",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanMembers": {
"description": "VLAN Members of the ethernet port profile",
"type": "string"
},
"dynamicVlanEnabled": {
"type": "boolean"
},
"guestVlan": {
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"_8021X": {
"description": "VLAN 802.1X of the ethernet port profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"Disable",
"Supplicant",
"PortBasedAuthenticator",
"MACBasedAuthenticator"
]
},
"authenticator": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"authentication": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enableUseSCGasProxy": {
"type": "boolean"
},
"server": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"enableUseSCGasProxy"
]
},
"disabledAccounting": {
"type": "boolean"
},
"accounting": {
"desciption": "null mean Disabled",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enableUseSCGasProxy": {
"type": "boolean"
},
"server": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"enableUseSCGasProxy"
]
},
"macAuthByPassEnabled": {
"type": "boolean"
}
},
"required": [
"macAuthByPassEnabled"
]
},
"supplicant": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"MACAddress",
"Custom"
]
},
"userName": {
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
}
},
"required": [
"name",
"type",
"_8021X"
]
}
201
Body
{
"id": "2"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify - Ethernet Port Porfile ¶
PATCH/v6_1/rkszones/{zoneId}/profile/ethernetPort/{id}
Modify a specific Ethernet Port Porfile.
Body
{
"name": "modify-ethport",
"id": "13",
"description": "modify-ethport",
"type": "TrunkPort",
"tunnelEnabled": null,
"untagId": 1,
"vlanMembers": "1-4094",
"dynamicVlanEnabled": false,
"guestVlan": null,
"_8021X": {
"type": "Supplicant",
"authenticator": null,
"supplicant": {
"type": "Custom",
"userName": "testuser",
"password": "testpassword"
}
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "name of the ethernet port profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the ethernet port profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tunnelEnabled": {
"description": "tunnelEnabled of the ethernet port profile for AccessPort type",
"type": "boolean"
},
"untagId": {
"description": "VLAN Untag ID of the ethernet port profile",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanMembers": {
"description": "VLAN Members of the ethernet port profile",
"type": "string"
},
"dynamicVlanEnabled": {
"type": "boolean"
},
"guestVlan": {
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"_8021X": {
"description": "VLAN 802.1X of the ethernet port profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"Disable",
"Supplicant",
"PortBasedAuthenticator",
"MACBasedAuthenticator"
]
},
"authenticator": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"authentication": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enableUseSCGasProxy": {
"type": "boolean"
},
"server": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"enableUseSCGasProxy"
]
},
"disabledAccounting": {
"type": "boolean"
},
"accounting": {
"desciption": "null mean Disabled",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enableUseSCGasProxy": {
"type": "boolean"
},
"server": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"enableUseSCGasProxy"
]
},
"macAuthByPassEnabled": {
"type": "boolean"
}
},
"required": [
"macAuthByPassEnabled"
]
},
"supplicant": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"MACAddress",
"Custom"
]
},
"userName": {
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
}
}
}
204
Modify - _8021X of Ethernet Port Porfile ¶
PATCH/v6_1/rkszones/{zoneId}/profile/ethernetPort/{id}/_8021X
Modify _8021X of Ethernet Port Porfile.
Body
{
"type": "Supplicant",
"authenticator": null,
"supplicant": {
"type": "Custom",
"userName": "testuser",
"password": "testpassword"
}
}
Schema
{
"description": "VLAN 802.1X of the ethernet port profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"Disable",
"Supplicant",
"PortBasedAuthenticator",
"MACBasedAuthenticator"
]
},
"authenticator": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"authentication": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enableUseSCGasProxy": {
"type": "boolean"
},
"server": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"enableUseSCGasProxy"
]
},
"disabledAccounting": {
"type": "boolean"
},
"accounting": {
"desciption": "null mean Disabled",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enableUseSCGasProxy": {
"type": "boolean"
},
"server": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"enableUseSCGasProxy"
]
},
"macAuthByPassEnabled": {
"type": "boolean"
}
},
"required": [
"macAuthByPassEnabled"
]
},
"supplicant": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"MACAddress",
"Custom"
]
},
"userName": {
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
}
204
VlanPooling ¶
Retrieve List ¶
POST/v6_1/vlanpoolings/query
Use this API command to retrieve a list of VLAN poolings. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "OR",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "name",
"dir": "ASC"
},
"page": 1,
"limit": 10
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "ffbcfde0-e9bf-11e6-b761-64006a6a50c6",
"name": "vlanPooling",
"description": "",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"pool": "2",
"algo": "MAC_HASH"
}
],
"extra": {
"rbacMetadata": [
{
"WLAN_CATEGORY": "FULL_ACCESS"
}
]
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for User Traffic profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"pool": {
"description": "VLANs of the VLAN pooling profile",
"type": "string"
},
"algo": {
"description": "Algorithm of the VLAN pooling profile",
"default": "MAC_HASH",
"enum": [
"MAC_HASH"
]
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
},
"description": {
"description": "Description of the service",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/vlanpoolings/{id}
Use this API command to retrieve VLAN pooling.
200
Body
{
"id": "d18e44e0-8af5-11e4-8155-000c299b4765",
"name": "zoneVlanPooling",
"description": "modify basic configuration",
"domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
"pool": "3,12-18",
"algo": "MAC_HASH"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the VLAN pooling profile",
"type": "string"
},
"domainId": {
"description": "Identifier of the domain which the VLAN pooling profile belongs to",
"type": "string"
},
"name": {
"description": "Name of the VLAN pooling profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the VLAN pooling profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"pool": {
"description": "VLANs of the VLAN pooling profile",
"type": "string"
},
"algo": {
"description": "Algorithm of the VLAN pooling profile",
"enum": [
"MAC_HASH"
]
}
}
}
Create ¶
POST/v6_1/vlanpoolings
Use this API command to create new VLAN pooling.
Body
{
"name": "vlan pooling-test",
"description": "create description",
"pool": "3,12-18",
"algo": "MAC_HASH"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the VLAN pooling profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
},
"description": {
"description": "Description of the VLAN pooling profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"pool": {
"description": "VLANs of the VLAN pooling profile",
"type": "string"
},
"algo": {
"description": "Algorithm of the VLAN pooling profile",
"default": "MAC_HASH",
"enum": [
"MAC_HASH"
]
}
},
"required": [
"name",
"pool",
"algo"
]
}
201
Body
{
"id": "ffbcfde0-e9bf-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the created portal profile",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/vlanpoolings/{id}
Use this API command to modify the basic information on VLAN pooling.
Body
{
"name": "VlanPooling",
"description": "modify basic configuration",
"pool": "20-26",
"algo": "MAC_HASH"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the VLAN pooling profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the VLAN pooling profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"pool": {
"description": "VLANs of the VLAN pooling profile",
"type": "string"
},
"algo": {
"description": "Algorithm of the VLAN pooling profile",
"enum": [
"MAC_HASH"
]
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
204
Bulk Delete Vlan Pooling ¶
DELETE/v6_1/vlanpoolings
Use this API command to bulk delete VLAN pooling.
Body
{
"idList": [
"d18e44e0-8af5-11e4-8155-000c299b4765",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Bridge ¶
Retrieve List ¶
GET/v6_1/profiles/bridge
Use this API command to retrieve a list of Bridge profile.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"name": "new name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/profiles/bridge/{id}
Use this API command to retrieve Bridge profile by ID.
200
Body
{
"id": "profileUUID",
"name": "Bridge profile name",
"description": "Bridge profile description",
"dhcpRelay": {
"dhcpRelayEnabled": true,
"dhcpServer1": "172.13.22.5",
"dhcpServer2": "172.13.22.10",
"relayBothEnabled": false,
"dhcpOption82": {
"dhcpOption82Enabled": true,
"subopt1Enabled": true,
"subopt1Format": "AP_MAC_hex_ESSID",
"subopt2Enabled": true,
"subopt2Format": "AP_MAC_hex",
"subopt150Enabled": false,
"subopt151Enabled": true,
"subopt151Format": "AREA_NAME",
"subopt151AreaName": "testAreaName"
}
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "Name of Bridge profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bridge profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"dhcpRelay": {
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Query List ¶
POST/v6_1/profiles/bridge/query
Use this API command to query a list of Bridge profile. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "86ab95e0-dd46-11e6-bfbb-64006a6a50c6",
"name": "Factory Default",
"description": "The default bridge forwarding profile",
"dhcpRelay": {
"dhcpRelayEnabled": false,
"dhcpServer1": null,
"dhcpServer2": null,
"relayBothEnabled": null,
"dhcpOption82": null
},
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createDateTime": 1484720565821,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1484720565822,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}
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": "Profile Id",
"type": "string"
},
"name": {
"description": "Name of Bridge profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bridge profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"dhcpRelay": {
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
Create ¶
POST/v6_1/profiles/bridge
Use this API command to create Bridge profile.
Body
{
"name": "Bridge profile name",
"description": "Bridge profile description",
"dhcpRelay": {
"dhcpRelayEnabled": false
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "Name of Bridge profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bridge profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"dhcpRelay": {
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
},
"domainId": {
"description": "Domain Id",
"type": "string"
}
},
"required": [
"name"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/bridge/{id}
Use this API command to modify the basic information of Bridge profile.
Body
{
"name": "Bridge profile name",
"description": "Bridge profile description",
"dhcpRelay": {
"dhcpRelayEnabled": true,
"dhcpServer1": "172.13.22.5",
"dhcpServer2": "172.13.22.10",
"relayBothEnabled": false,
"dhcpOption82": {
"dhcpOption82Enabled": true,
"subopt1Enabled": true,
"subopt1Format": "AP_MAC_hex_ESSID",
"subopt2Enabled": true,
"subopt2Format": "AP_MAC_hex",
"subopt150Enabled": false,
"subopt151Enabled": true,
"subopt151Format": "AREA_NAME",
"subopt151AreaName": "testAreaName"
}
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "Name of Bridge profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the Bridge profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"dhcpRelay": {
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
},
"domainId": {
"description": "Domain Id",
"type": "string"
}
}
}
204
Modify DHCP Relay ¶
PATCH/v6_1/profiles/bridge/{id}/dhcpRelay
Use this API command to modify DHCP Relay of Bridge profile.
Body
{
"dhcpRelayEnabled": true,
"dhcpServer1": "172.13.22.5",
"dhcpServer2": "172.13.22.10",
"relayBothEnabled": false,
"dhcpOption82": {
"dhcpOption82Enabled": true,
"subopt1Enabled": true,
"subopt1Format": "AP_MAC_hex_ESSID",
"subopt2Enabled": true,
"subopt2Format": "AP_MAC_hex",
"subopt150Enabled": false,
"subopt151Enabled": true,
"subopt151Format": "AREA_NAME",
"subopt151AreaName": "testAreaName"
}
}
Schema
{
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
}
204
Delete ¶
DELETE/v6_1/profiles/bridge
Use this API command to delete multiple bridge profile.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
L2oGRE ¶
Retrieve List ¶
GET/v6_1/profiles/l2ogre
Use this API command to retrieve a list of L2oGRE profile.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"name": "new name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/profiles/l2ogre/{id}
Use this API command to retrieve L2oGRE profile by ID.
200
Body
{
"id": "profileUUID",
"name": "L2oGRE profile name",
"description": "L2oGRE profile description",
"coreNetworkGateway": {
"primaryGateway": "1.1.1.1",
"secondaryGateway": null,
"tunnelMTU": "AUTO",
"tunnelMTUSize": null,
"keepAlivePeriod": 10,
"keepAliveRetry": 3
},
"dhcpRelay": {
"dhcpRelayEnabled": true,
"dhcpServer1": "172.13.22.5",
"dhcpServer2": "172.13.22.10",
"relayBothEnabled": false,
"dhcpOption82": {
"dhcpOption82Enabled": true,
"subopt1Enabled": true,
"subopt1Format": "AP_MAC_hex_ESSID",
"subopt2Enabled": true,
"subopt2Format": "AP_MAC_hex",
"subopt150Enabled": false,
"subopt151Enabled": true,
"subopt151Format": "AREA_NAME",
"subopt151AreaName": "area name"
}
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "Name of L2oGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the L2oGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"coreNetworkGateway": {
"description": "Core Network Gateway",
"type": "object",
"additionalProperties": false,
"properties": {
"primaryGateway": {
"description": "Primary Gateway",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary Gateway",
"type": "string"
},
"tunnelMTU": {
"description": "Gateway path MTU",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMTUSize": {
"description": "Manual setting value of Gateway path MTU",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer",
"minimum": 1,
"maximum": 32767,
"default": 10
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer",
"minimum": 1,
"maximum": 255,
"default": 3
}
}
},
"dhcpRelay": {
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Query List ¶
POST/v6_1/profiles/l2ogre/query
Use this API command to query a list of L2oGRE profile. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "78098be1-e9db-11e6-952e-64006a6a50c6",
"name": "l2oGRE",
"description": "",
"coreNetworkGateway": {
"primaryGateway": "127.0.0.1",
"secondaryGateway": "",
"tunnelMTU": "AUTO",
"tunnelMTUSize": null,
"keepAlivePeriod": 10,
"keepAliveRetry": 3
},
"dhcpRelay": {
"dhcpRelayEnabled": false,
"dhcpServer1": null,
"dhcpServer2": null,
"relayBothEnabled": null,
"dhcpOption82": null
},
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createDateTime": 1486103950238,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486103950238,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}
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": "Profile Id",
"type": "string"
},
"name": {
"description": "Name of L2oGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the L2oGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"coreNetworkGateway": {
"description": "Core Network Gateway",
"type": "object",
"additionalProperties": false,
"properties": {
"primaryGateway": {
"description": "Primary Gateway",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary Gateway",
"type": "string"
},
"tunnelMTU": {
"description": "Gateway path MTU",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMTUSize": {
"description": "Manual setting value of Gateway path MTU",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer",
"minimum": 1,
"maximum": 32767,
"default": 10
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer",
"minimum": 1,
"maximum": 255,
"default": 3
}
}
},
"dhcpRelay": {
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
Create ¶
POST/v6_1/profiles/l2ogre
Use this API command to create L2oGRE profile.
Body
{
"name": "L2oGRE profile create name",
"description": "L2oGRE profile create description",
"coreNetworkGateway": {
"primaryGateway": "1.1.1.1",
"tunnelMTU": "AUTO",
"keepAlivePeriod": 10,
"keepAliveRetry": 3
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "Name of L2oGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the L2oGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"coreNetworkGateway": {
"description": "Core Network Gateway",
"type": "object",
"additionalProperties": false,
"properties": {
"primaryGateway": {
"description": "Primary Gateway",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary Gateway",
"type": "string"
},
"tunnelMTU": {
"description": "Gateway path MTU",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMTUSize": {
"description": "Manual setting value of Gateway path MTU",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer",
"minimum": 1,
"maximum": 32767,
"default": 10
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer",
"minimum": 1,
"maximum": 255,
"default": 3
}
}
},
"dhcpRelay": {
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
},
"domainId": {
"description": "Domain Id",
"type": "string"
}
},
"required": [
"name",
"coreNetworkGateway"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/l2ogre/{id}
Use this API command to modify the basic information of L2oGRE profile.
Body
{
"name": "L2oGRE profile modify name",
"description": "L2oGRE profile modify description",
"coreNetworkGateway": {
"primaryGateway": "1.1.1.1",
"tunnelMTU": "MANUAL",
"tunnelMTUSize": 1500,
"keepAlivePeriod": 10,
"keepAliveRetry": 3
},
"dhcpRelay": {
"dhcpRelayEnabled": true,
"dhcpServer1": "172.13.22.5",
"dhcpServer2": "172.13.22.10",
"relayBothEnabled": false,
"dhcpOption82": {
"dhcpOption82Enabled": true,
"subopt1Enabled": true,
"subopt1Format": "AP_MAC_hex_ESSID",
"subopt2Enabled": true,
"subopt2Format": "AP_MAC_hex",
"subopt150Enabled": false,
"subopt151Enabled": true,
"subopt151Format": "AREA_NAME",
"subopt151AreaName": "testAreaName"
}
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "Name of L2oGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the L2oGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"coreNetworkGateway": {
"description": "Core Network Gateway",
"type": "object",
"additionalProperties": false,
"properties": {
"primaryGateway": {
"description": "Primary Gateway",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary Gateway",
"type": "string"
},
"tunnelMTU": {
"description": "Gateway path MTU",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMTUSize": {
"description": "Manual setting value of Gateway path MTU",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer",
"minimum": 1,
"maximum": 32767,
"default": 10
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer",
"minimum": 1,
"maximum": 255,
"default": 3
}
}
},
"dhcpRelay": {
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
},
"domainId": {
"description": "Domain Id",
"type": "string"
}
}
}
204
Modify Core Network Gateway ¶
PATCH/v6_1/profiles/l2ogre/{id}/coreNetworkGateway
Use this API command to modify Core Network Gateway of a L2oGRE profile.
Body
{
"primaryGateway": "1.1.1.1",
"tunnelMTU": "MANUAL",
"tunnelMTUSize": 1500,
"keepAlivePeriod": 10,
"keepAliveRetry": 3
}
Schema
{
"description": "Core Network Gateway",
"type": "object",
"additionalProperties": false,
"properties": {
"primaryGateway": {
"description": "Primary Gateway",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary Gateway",
"type": "string"
},
"tunnelMTU": {
"description": "Gateway path MTU",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMTUSize": {
"description": "Manual setting value of Gateway path MTU",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer",
"minimum": 1,
"maximum": 32767,
"default": 10
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer",
"minimum": 1,
"maximum": 255,
"default": 3
}
}
}
204
Modify DHCP Relay ¶
PATCH/v6_1/profiles/l2ogre/{id}/dhcpRelay
Use this API command to modify DHCP Relay of L2oGRE profile.
Body
{
"dhcpRelayEnabled": true,
"dhcpServer1": "172.13.22.5",
"dhcpServer2": "172.13.22.10",
"relayBothEnabled": false,
"dhcpOption82": {
"dhcpOption82Enabled": true,
"subopt1Enabled": true,
"subopt1Format": "AP_MAC_hex_ESSID",
"subopt2Enabled": true,
"subopt2Format": "AP_MAC_hex",
"subopt150Enabled": false,
"subopt151Enabled": true,
"subopt151Format": "AREA_NAME",
"subopt151AreaName": "testAreaName"
}
}
Schema
{
"description": "DHCP Relay",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpRelayEnabled": {
"description": "Enable DHCP Relay",
"type": "boolean"
},
"dhcpServer1": {
"description": "DHCP Server 1",
"type": "string"
},
"dhcpServer2": {
"description": "DHCP Server 2",
"type": "string"
},
"relayBothEnabled": {
"description": "Send DHCP requests to both servers simultaneously.",
"type": "boolean"
},
"dhcpOption82": {
"description": "DHCP Option 82",
"type": "object",
"additionalProperties": false,
"properties": {
"dhcpOption82Enabled": {
"description": "Enable DHCP Option 82",
"type": "boolean"
},
"subopt1Enabled": {
"description": "Enable subopt-1",
"type": "boolean"
},
"subopt1Format": {
"description": "Subopt-1 format",
"enum": [
"AP_INFO",
"AP_MAC_hex",
"AP_MAC_hex_ESSID",
"AP_INFO_LOCATION"
]
},
"subopt2Enabled": {
"description": "Enable subopt-2",
"type": "boolean"
},
"subopt2Format": {
"description": "Subopt-2 format",
"enum": [
"CLIENT_MAC_hex",
"CLIENT_MAC_hex_ESSID",
"AP_MAC_hex",
"AP_MAC__hex_ESSID"
]
},
"subopt150Enabled": {
"description": "Subopt-150 with VLAN",
"type": "boolean"
},
"subopt151Enabled": {
"description": "Enable subopt-151",
"type": "boolean"
},
"subopt151Format": {
"description": "Subopt-151 format",
"enum": [
"AREA_NAME",
"ESSID"
]
},
"subopt151AreaName": {
"description": "Subopt-151 Area Name value",
"type": "string"
}
}
}
}
}
204
Delete ¶
DELETE/v6_1/profiles/l2ogre
Use this API command to delete multiple L2oGRE profile.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Identity User Role ¶
Retrieve List ¶
GET/v6_1/identity/userrole
Use this API command to retrieve a list of identity user role.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "identity name",
"description": "identity user role desc",
"userTrafficProfile": {
"id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
"name": "userTrafficProfile"
},
"maxDevices": {
"maxDevicesAllowed": "UNLIMITED",
"maxDevicesNumber": 0
},
"vlanId": 2,
"vlanPooling": {
"id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
"name": "vlanPooling"
}
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "identity name",
"description": "identity user role desc",
"userTrafficProfile": {
"id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
"name": "userTrafficProfile"
},
"maxDevices": {
"maxDevicesAllowed": "UNLIMITED",
"maxDevicesNumber": 0
},
"vlanId": 2,
"vlanPooling": {
"id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
"name": "vlanPooling"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for Identity roles",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"userTrafficProfile": {
"description": "User traffic profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"vlanId": {
"description": "vlan id",
"type": "integer"
},
"vlanPooling": {
"description": "VLAN pooling profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve List ¶
POST/v6_1/identity/userRoleList
Use this API command to retrieve a list of identity user role.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name": "identity name",
"description": "identity user role desc",
"userTrafficProfile": {
"id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
"name": "userTrafficProfile"
},
"maxDevices": {
"maxDevicesAllowed": "UNLIMITED",
"maxDevicesNumber": 0
},
"vlanId": 2,
"vlanPooling": {
"id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
"name": "vlanPooling"
}
},
{
"id": "15efd160-7153-11e4-aa08-00606eb0c700",
"name": "identity name",
"description": "identity user role desc",
"userTrafficProfile": {
"id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
"name": "userTrafficProfile"
},
"maxDevices": {
"maxDevicesAllowed": "UNLIMITED",
"maxDevicesNumber": 0
},
"vlanId": 2,
"vlanPooling": {
"id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
"name": "vlanPooling"
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for Identity roles",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the service",
"type": "string"
},
"name": {
"description": "Name of the service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"userTrafficProfile": {
"description": "User traffic profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"vlanId": {
"description": "vlan id",
"type": "integer"
},
"vlanPooling": {
"description": "VLAN pooling profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/identity/userrole/{id}
Use this API command to retrieve identity user role by ID.
200
Body
{
"id": "e5db11b3-71ff-4234-80d0-c7562e9868af",
"name": "identity user role name",
"description": "identity user role desc",
"userTrafficProfile": {
"id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
"name": "userTrafficProfile"
},
"maxDevices": {
"maxDevicesAllowed": "UNLIMITED",
"maxDevicesNumber": 0
},
"vlanId": 2,
"vlanPooling": {
"id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
"name": "vlanPooling"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the object",
"type": "string"
},
"name": {
"description": "name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"userTrafficProfile": {
"description": "User traffic profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"vlanId": {
"description": "vlan id",
"type": "integer"
},
"vlanPooling": {
"description": "VLAN pooling profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create ¶
POST/v6_1/identity/userrole
Use this API command to create identity user role.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "create-identity-user-role-name",
"description": "create identity user role desc",
"userTrafficProfile": {
"name": "utp"
},
"maxDevices": {
"maxDevicesAllowed": "LIMITED",
"maxDevicesNumber": 3
},
"vlanId": 2,
"vlanPooling": {
"name": "vlanPooling"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"userTrafficProfile": {
"description": "User traffic profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"vlanId": {
"description": "vlan id",
"type": "integer"
},
"vlanPooling": {
"description": "VLAN pooling profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"name",
"userTrafficProfile",
"maxDevices"
]
}
201
Body
{
"id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/identity/userrole/{id}
Use this API command to modify the basic information of identity user role.
Body
{
"name": "modify-userrole-test",
"description": "modify user role test",
"userTrafficProfile": {
"name": "userTrafficProfileName"
},
"maxDevices": {
"maxDevicesAllowed": "LIMITED",
"maxDevicesNumber": 3
},
"vlanId": 2,
"vlanPooling": {
"name": "vlanPooling"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"userTrafficProfile": {
"description": "User traffic profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"vlanId": {
"description": "vlan id",
"type": "integer"
},
"vlanPooling": {
"description": "VLAN pooling profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
204
Modify max device ¶
PATCH/v6_1/identity/userrole/{id}/maxDevices
Use this API command to modify max device allowed of identity user role.
Body
{
"maxDevicesAllowed": "LIMITED",
"maxDevicesNumber": 3
}
Schema
{
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
}
204
Modify user traffic profile ¶
PATCH/v6_1/identity/userrole/{id}/userTrafficProfile
Use this API command to modify user traffic profile of identity user role.
Body
{
"name": "userTrafficProfileName"
}
Schema
{
"description": "User traffic profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Modify VLAN pooling ¶
PATCH/v6_1/identity/userrole/{id}/vlanPooling
Use this API command to modify VLAN pooling of identity user role.
Body
{
"name": "vlanPooling"
}
Schema
{
"description": "VLAN pooling profile",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Delete ¶
Delete Multiple Identity User Roles ¶
DELETE/v6_1/identity/userrole
Use this API command to delete multiple identity user roles.
Body
{
"idList": [
"b5f02dbf-c769-436d-ae2d-44a6af194b57",
"839f87c6-d116-497e-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
AP Registration Rules ¶
Retrieve List ¶
GET/v6_1/apRules
Use this API command to retrieve a list of AP Registration Rules profile.
200
Body
{
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "f031d790-f2dd-11e4-b4f9-000c292547b9",
"priority": 1,
"description": "aprule1"
},
{
"id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
"priority": 2,
"description": "aprule2"
},
{
"id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
"priority": 3,
"description": "aprule3"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP Registration Rules",
"type": "string"
},
"priority": {
"description": "priority of the AP Registration Rules",
"type": "integer"
},
"description": {
"description": "Description of the AP Registration Rules",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/apRules/{id}
Use this API command to retrieve AP Registration Rules profile by ID.
200
Body
{
"id": "f031d790-f2dd-11e4-b4f9-000c292547b9",
"priority": 1,
"description": "aprule1",
"type": "IPAddressRange",
"ipAddressRange": {
"fromIp": "11.11.11.17",
"toIp": "11.11.11.18"
},
"subnet": null,
"gpsCoordinates": null,
"provisionTag": null,
"mobilityZone": {
"id": "1690614e-1c1f-4fe8-9144-24ccf28d83c4",
"name": "api-test-zone"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP Registration Rules",
"type": "string"
},
"priority": {
"description": "priority of the AP Registration Rules",
"type": "integer"
},
"description": {
"description": "Description of the AP Registration Rules",
"type": [
"string",
"null"
],
"maxLength": 64
},
"type": {
"description": "type of the AP Registration Rules",
"enum": [
"IPAddressRange",
"Subnet",
"GPSCoordinates",
"ProvisionTag"
]
},
"ipAddressRange": {
"description": "IPAddressRange of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"fromIp": {
"description": "from IP Address",
"type": "string"
},
"toIp": {
"description": "to IP Address",
"type": "string"
}
}
},
"subnet": {
"description": "Subnet of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "networkAddress",
"type": "string"
},
"subnetMask": {
"description": "subnetMask",
"type": "string"
}
}
},
"gpsCoordinates": {
"description": "GPSCoordinates of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"latitude": {
"description": "latitude",
"type": "number"
},
"longitude": {
"description": "longitude",
"type": "number"
},
"distance": {
"description": "distance",
"type": "number"
}
}
},
"provisionTag": {
"description": "ProvisionTag of the AP Registration Rules",
"pattern": "^[!-~]([!-~]){0,31}$"
},
"mobilityZone": {
"description": "mobilityZone of the AP Registration Rules",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
Create ¶
POST/v6_1/apRules
Use this API command to create AP Registration Rules profile.
Body
{
"description": "postman_aprule",
"type": "IPAddressRange",
"ipAddressRange": {
"fromIp": "11.11.11.11",
"toIp": "11.11.11.13"
},
"mobilityZone": {
"id": "1690614e-1c1f-4fe8-9144-24ccf28d83c4"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "Description of the AP Registration Rules",
"type": [
"string",
"null"
],
"maxLength": 64
},
"type": {
"description": "type of the AP Registration Rules",
"enum": [
"IPAddressRange",
"Subnet",
"GPSCoordinates",
"ProvisionTag"
]
},
"ipAddressRange": {
"description": "IPAddressRange of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"fromIp": {
"description": "from IP Address",
"type": "string"
},
"toIp": {
"description": "to IP Address",
"type": "string"
}
}
},
"subnet": {
"description": "Subnet of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "networkAddress",
"type": "string"
},
"subnetMask": {
"description": "subnetMask",
"type": "string"
}
}
},
"gpsCoordinates": {
"description": "GPSCoordinates of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"latitude": {
"description": "latitude",
"type": "number"
},
"longitude": {
"description": "longitude",
"type": "number"
},
"distance": {
"description": "distance",
"type": "number"
}
}
},
"provisionTag": {
"description": "ProvisionTag of the AP Registration Rules",
"pattern": "^[!-~]([!-~]){0,31}$"
},
"mobilityZone": {
"description": "mobilityZone of the AP Registration Rules",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"type",
"mobilityZone"
]
}
201
Body
{
"id": "f031d790-f2dd-11e4-b4f9-000c292547b9"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/apRules/{id}
Use this API command to modify the basic information of AP Registration Rules profile.
Body
{
"description": "postman_aprule",
"type": "Subnet",
"provisionTag": "provisiontag",
"ipAddressRange": {
"fromIp": "11.11.11.11",
"toIp": "11.11.11.13"
},
"subnet": {
"networkAddress": "11.11.11.11",
"subnetMask": "255.255.0.0"
},
"gpsCoordinates": {
"latitude": 50.11,
"longitude": 100.533,
"distance": 10
},
"mobilityZone": {
"id": "1690614e-1c1f-4fe8-9144-24ccf28d83c4"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "Description of the AP Registration Rules",
"type": [
"string",
"null"
],
"maxLength": 64
},
"type": {
"description": "type of the AP Registration Rules",
"enum": [
"IPAddressRange",
"Subnet",
"GPSCoordinates",
"ProvisionTag"
]
},
"provisionTag": {
"description": "ProvisionTag of the AP Registration Rules",
"type": "string",
"pattern": "^[!-~]([!-~]){0,31}$"
},
"mobilityZone": {
"description": "mobilityZone of the AP Registration Rules",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"ipAddressRange": {
"description": "IPAddressRange of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"fromIp": {
"description": "from IP Address",
"type": "string"
},
"toIp": {
"description": "to IP Address",
"type": "string"
}
}
},
"subnet": {
"description": "Subnet of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "networkAddress",
"type": "string"
},
"subnetMask": {
"description": "subnetMask",
"type": "string"
}
}
},
"gpsCoordinates": {
"description": "GPSCoordinates of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"latitude": {
"description": "latitude",
"type": "number"
},
"longitude": {
"description": "longitude",
"type": "number"
},
"distance": {
"description": "distance",
"type": "number"
}
}
}
}
}
204
Modify IP Address Range ¶
PATCH/v6_1/apRules/{id}/ipAddressRange
Use this API command to modify IP Address Range of a AP Registration Rules profile.
Body
{
"fromIp": "11.11.11.11",
"toIp": "11.11.11.13"
}
Schema
{
"description": "IPAddressRange of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"fromIp": {
"description": "from IP Address",
"type": "string"
},
"toIp": {
"description": "to IP Address",
"type": "string"
}
}
}
204
Modify Subnet ¶
PATCH/v6_1/apRules/{id}/subnet
Use this API command to modify subnet of AP Registration Rules profile.
Body
{
"networkAddress": "11.11.11.11",
"subnetMask": "255.255.0.0"
}
Schema
{
"description": "Subnet of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "networkAddress",
"type": "string"
},
"subnetMask": {
"description": "subnetMask",
"type": "string"
}
}
}
204
Modify GPSCoordinates ¶
PATCH/v6_1/apRules/{id}/gpsCoordinates
Use this API command to modify GPSCoordinates of AP Registration Rules profile.
Body
{
"latitude": 50.11,
"longitude": 100.533,
"distance": 10
}
Schema
{
"description": "GPSCoordinates of the AP Registration Rules",
"type": "object",
"additionalProperties": false,
"properties": {
"latitude": {
"description": "latitude",
"type": "number"
},
"longitude": {
"description": "longitude",
"type": "number"
},
"distance": {
"description": "distance",
"type": "number"
}
}
}
204
Modify mobilityZone ¶
PATCH/v6_1/apRules/{id}/mobilityZone
Use this API command to modify mobilityZone of AP Registration Rules profile.
Body
{
"id": "1690614e-1c1f-4fe8-9144-24ccf28d83c4"
}
Schema
{
"description": "mobilityZone of the AP Registration Rules",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Delete ¶
RuckusGRE Tunnel Profile ¶
Retrieve List ¶
GET/v6_1/profiles/tunnel/ruckusgre
Use this API command to retrieve a list of RuckusGRE tunnel profile.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"name": "new name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/profiles/tunnel/ruckusgre/{id}
Use this API command to retrieve RuckusGRE tunnel profile.
200
Body
{
"name": "RuckusGRE tunnel profile name",
"description": "RuckusGRE tunnel profile description",
"tunnelMode": "GRE",
"enableTunnelEncryption": false,
"tunnelMtuAutoEnabled": "MANUAL",
"tunnelMtuSize": 1500
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "name of the RuckusGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the RuckusGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tunnelMode": {
"description": "Ruckus Tunnel Mode of RuckusGRE profile",
"enum": [
"GRE",
"GREUDP"
]
},
"enableTunnelEncryption": {
"description": "Tunnel Encryption of the RuckusGRE profile",
"type": "boolean"
},
"tunnelMtuAutoEnabled": {
"description": "WAN Interface MTU of the RuckusGRE profile",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMtuSize": {
"description": "Tunnel MTU size of RuckusGRE profile",
"type": "integer"
},
"domainId": {
"description": "Domain id of the RuckusGRE profile",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create ¶
POST/v6_1/profiles/tunnel/ruckusgre
Use this API command to create RuckusGRE tunnel profile.
Body
{
"name": "RuckusGRE tunnel profile name",
"description": "RuckusGRE tunnel profile description",
"tunnelMode": "GREUDP",
"enableTunnelEncryption": false,
"tunnelMtuAutoEnabled": "AUTO"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "name of the RuckusGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the RuckusGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tunnelMode": {
"description": "Ruckus Tunnel Mode of RuckusGRE profile",
"enum": [
"GRE",
"GREUDP"
]
},
"enableTunnelEncryption": {
"description": "Tunnel Encryption of the RuckusGRE profile",
"type": "boolean",
"default": false
},
"tunnelMtuAutoEnabled": {
"description": "WAN Interface MTU of the RuckusGRE profile",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMtuSize": {
"description": "Tunnel MTU size of RuckusGRE profile",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"domainId": {
"description": "Domain id of the RuckusGRE profile",
"type": "string"
}
},
"required": [
"name",
"tunnelMtuAutoEnabled"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/tunnel/ruckusgre/{id}
Use this API command to modify the basic information of RuckusGRE tunnel profile.
Body
{
"name": "RuckusGRE tunnel profile name",
"description": "RuckusGRE tunnel profile description",
"tunnelMode": "GRE",
"enableTunnelEncryption": false,
"tunnelMtuAutoEnabled": "MANUAL",
"tunnelMtuSize": 1500
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "name of the RuckusGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the RuckusGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tunnelMode": {
"description": "Ruckus Tunnel Mode of RuckusGRE profile",
"enum": [
"GRE",
"GREUDP"
]
},
"enableTunnelEncryption": {
"description": "Tunnel Encryption of the RuckusGRE profile",
"type": "boolean",
"default": false
},
"tunnelMtuAutoEnabled": {
"description": "WAN Interface MTU of the RuckusGRE profile",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMtuSize": {
"description": "Tunnel MTU size of RuckusGRE profile",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"domainId": {
"description": "Domain id of the RuckusGRE profile",
"type": "string"
}
}
}
204
Delete ¶
DELETE/v6_1/profiles/tunnel/ruckusgre/{id}
Use this API command to delete RuckusGRE tunnel profile.
204
Delete ¶
DELETE/v6_1/profiles/tunnel/ruckusgre
Use this API command to delete multiple RuckusGRE tunnel profile.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Query List ¶
POST/v6_1/profiles/tunnel/ruckusgre/query
Use this API command to query a list of RuckusGRE tunnel profile. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"name": "RuckusGRE tunnel profile name",
"description": "RuckusGRE tunnel profile description",
"tunnelMode": "GRE",
"enableTunnelEncryption": false,
"tunnelMtuAutoEnabled": "MANUAL",
"tunnelMtuSize": 1500
}
]
}
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": "Profile Id",
"type": "string"
},
"name": {
"description": "name of the RuckusGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the RuckusGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"tunnelMode": {
"description": "Ruckus Tunnel Mode of RuckusGRE profile",
"enum": [
"GRE",
"GREUDP"
]
},
"enableTunnelEncryption": {
"description": "Tunnel Encryption of the RuckusGRE profile",
"type": "boolean"
},
"tunnelMtuAutoEnabled": {
"description": "WAN Interface MTU of the RuckusGRE profile",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMtuSize": {
"description": "Tunnel MTU size of RuckusGRE profile",
"type": "integer"
},
"domainId": {
"description": "Domain id of the RuckusGRE profile",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
SoftGRE Tunnel Profile ¶
Retrieve List ¶
GET/v6_1/profiles/tunnel/softgre
Use this API command to retrieve a list of SoftGRE tunnel profile.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "267ef3a0-738b-11e4-96d5-0a7820524153",
"name": "new name"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/profiles/tunnel/softgre/{id}
Use this API command to retrieve SoftGRE tunnel profile.
200
Body
{
"name": "SoftGRE tunnel profile name",
"description": "SoftGRE tunnel profile description",
"ipMode": "IPV6",
"primaryGateway": "2222:3333::5555",
"secondaryGateway": "2222:3333::1111",
"tunnelMtuAutoEnabled": "MANUAL",
"tunnelMtuSize": 1500,
"keepAlivePeriod": 10,
"keepAliveRetry": 5,
"forceDisassociateClient": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "name of the SoftGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the SoftGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ipMode": {
"description": "Gateway IP Mode of SoftGRE profile",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"primaryGateway": {
"description": "Primary gateway address of the SoftGRE profile",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary gateway address of the SoftGRE profile",
"type": "string"
},
"tunnelMtuAutoEnabled": {
"description": "WAN Interface MTU of the SoftGRE profile",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMtuSize": {
"description": "Tunnel MTU size of SoftGRE profile",
"type": "integer"
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer"
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer"
},
"forceDisassociateClient": {
"description": "Force Disassociate Client",
"type": "boolean"
},
"domainId": {
"description": "Domain id of the SoftGRE profile",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create ¶
POST/v6_1/profiles/tunnel/softgre
Use this API command to create SoftGRE tunnel profile.
Body
{
"name": "SoftGRE tunnel profile name",
"description": "SoftGRE tunnel profile description",
"ipMode": "IPV4",
"primaryGateway": "172.18.110.29",
"secondaryGateway": "192.168.10.1",
"tunnelMtuAutoEnabled": "MANUAL",
"tunnelMtuSize": 1500,
"keepAlivePeriod": 10,
"keepAliveRetry": 5,
"forceDisassociateClient": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "name of the SoftGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the SoftGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ipMode": {
"description": "Gateway IP Mode of SoftGRE profile",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"primaryGateway": {
"description": "Primary gateway address of the SoftGRE profile",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary gateway address of the SoftGRE profile",
"type": "string"
},
"tunnelMtuAutoEnabled": {
"description": "WAN Interface MTU of the SoftGRE profile",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMtuSize": {
"description": "Tunnel MTU size of SoftGRE profile. IPV4:850-1500, IPV6:1384-1500. Default 1500.",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer",
"minimum": 1,
"maximum": 180,
"default": 10
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer",
"minimum": 2,
"maximum": 20,
"default": 5
},
"forceDisassociateClient": {
"description": "Force Disassociate Client",
"type": "boolean"
},
"domainId": {
"description": "Domain id of the SoftGRE profile",
"type": "string"
}
},
"required": [
"name",
"primaryGateway",
"tunnelMtuAutoEnabled",
"keepAlivePeriod",
"keepAliveRetry"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/tunnel/softgre/{id}
Use this API command to modify the basic information of SoftGRE tunnel profile.
Body
{
"name": "SoftGRE tunnel profile name",
"description": "SoftGRE tunnel profile description",
"primaryGateway": "172.18.110.50",
"secondaryGateway": "192.168.10.2",
"tunnelMtuAutoEnabled": "AUTO",
"keepAlivePeriod": 10,
"keepAliveRetry": 5,
"forceDisassociateClient": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "name of the SoftGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the SoftGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primaryGateway": {
"description": "Primary gateway address of the SoftGRE profile",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary gateway address of the SoftGRE profile",
"type": "string"
},
"tunnelMtuAutoEnabled": {
"description": "WAN Interface MTU of the SoftGRE profile",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMtuSize": {
"description": "Tunnel MTU size of SoftGRE profile. IPV4:850-1500, IPV6:1384-1500. Default 1500.",
"type": "integer",
"minimum": 850,
"maximum": 1500,
"default": 1500
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer",
"minimum": 1,
"maximum": 180,
"default": 10
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer",
"minimum": 2,
"maximum": 20,
"default": 5
},
"forceDisassociateClient": {
"description": "Force Disassociate Client",
"type": "boolean"
},
"domainId": {
"description": "Domain id of the SoftGRE profile",
"type": "string"
}
}
}
204
Delete ¶
DELETE/v6_1/profiles/tunnel/softgre/{id}
Use this API command to delete SoftGRE tunnel profile.
204
Delete ¶
DELETE/v6_1/profiles/tunnel/softgre
Use this API command to delete multiple SoftGRE tunnel profile.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Query List ¶
POST/v6_1/profiles/tunnel/softgre/query
Use this API command to query a list of SoftGRE tunnel profile. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"name": "SoftGRE tunnel profile name",
"description": "SoftGRE tunnel profile description",
"ipMode": "IPV6",
"primaryGateway": "2222:3333::5555",
"secondaryGateway": "2222:3333::1111",
"tunnelMtuAutoEnabled": "MANUAL",
"tunnelMtuSize": 1500,
"keepAlivePeriod": 10,
"keepAliveRetry": 5,
"forceDisassociateClient": false
}
]
}
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": "Profile Id",
"type": "string"
},
"name": {
"description": "name of the SoftGRE profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the SoftGRE profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ipMode": {
"description": "Gateway IP Mode of SoftGRE profile",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"primaryGateway": {
"description": "Primary gateway address of the SoftGRE profile",
"type": "string"
},
"secondaryGateway": {
"description": "Secondary gateway address of the SoftGRE profile",
"type": "string"
},
"tunnelMtuAutoEnabled": {
"description": "WAN Interface MTU of the SoftGRE profile",
"enum": [
"AUTO",
"MANUAL"
]
},
"tunnelMtuSize": {
"description": "Tunnel MTU size of SoftGRE profile",
"type": "integer"
},
"keepAlivePeriod": {
"description": "ICMP Keep-Alive Period(secs)",
"type": "integer"
},
"keepAliveRetry": {
"description": "ICMP Keep-Alive Retry",
"type": "integer"
},
"forceDisassociateClient": {
"description": "Force Disassociate Client",
"type": "boolean"
},
"domainId": {
"description": "Domain id of the SoftGRE profile",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
LBS profile ¶
Create LBS profile ¶
GET/v6_1/profiles/lbs/{id}
Retrieve LBS profile.
200
Body
{
"venue": "Venue name",
"url": "172.17.60.79",
"port": "8883",
"password": "pwd$321"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "LBS name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "LBS description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"url": {
"description": "LBS url",
"type": "string"
},
"port": {
"description": "LBS port",
"type": "integer"
},
"password": {
"description": "Password",
"type": "string"
},
"venue": {
"description": "Venue",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create LBS profile ¶
POST/v6_1/profiles/lbs
Create LBS profile.
Body
{
"venue": "Venue name",
"url": "172.17.60.79",
"port": "8883",
"password": "pwd$321"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "LBS name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "LBS description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"url": {
"description": "LBS url",
"type": "string"
},
"port": {
"description": "LBS port",
"type": "integer"
},
"password": {
"description": "Password",
"type": "string"
},
"venue": {
"description": "Venue",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
200
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Update LBS profile ¶
PATCH/v6_1/profiles/lbs/{id}
Update LBS profile.
Body
{
"venue": "Venue name",
"url": "172.17.60.79",
"port": "8883",
"password": "pwd$321"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile Id",
"type": "string"
},
"name": {
"description": "LBS name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "LBS description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"url": {
"description": "LBS url",
"type": "string"
},
"port": {
"description": "LBS port",
"type": "integer"
},
"password": {
"description": "Password",
"type": "string"
},
"venue": {
"description": "Venue",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
200
Delete multiple LBS profile ¶
DELETE/v6_1/profiles/lbs
Delete multiple LBS profile.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
200
Query LBS profiles ¶
POST/v6_1/profiles/lbs/query
Query LBS profiles. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"createDateTime": 1484720657214,
"modifiedDateTime": 1484720657215,
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"creatorUsername": "Admin",
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "Admin",
"name": "Venue1",
"url": "lbs.ruckuswireless.com",
"port": 50,
"password": null,
"venue": "Venue1",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "bd24e5e1-dd46-11e6-bfbb-64006a6a50c6"
},
{
"createDateTime": 1484720657237,
"modifiedDateTime": 1484720657237,
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"creatorUsername": "Admin",
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "Admin",
"name": "Venue2",
"url": "lbs.ruckuswireless.com",
"port": 50,
"password": null,
"venue": "Venue2",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "bd286851-dd46-11e6-bfbb-64006a6a50c6"
}
],
"extra": {}
}
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": "Profile Id",
"type": "string"
},
"name": {
"description": "LBS name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "LBS description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"url": {
"description": "LBS url",
"type": "string"
},
"port": {
"description": "LBS port",
"type": "integer"
},
"password": {
"description": "Password",
"type": "string"
},
"venue": {
"description": "Venue",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
Precedence Profile ¶
Create Precedence Profile ¶
POST/v6_1/precedence
Use this API command to create Precedence Profile.
Body
{
"name": "precedence-name01",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"vlanPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLAN"
}
],
"rateLimitingPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLANUTP"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the precedence profile",
"minLength": 2,
"maxLength": 32,
"type": "string",
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"vlanPrecedence": {
"type": "array",
"description": "vlan precedence",
"items": {
"type": "object",
"description": "Vlan precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLAN"
],
"description": "Name of the Vlan precedence item"
}
}
}
},
"rateLimitingPrecedence": {
"type": "array",
"description": "rate limiting precedence",
"items": {
"type": "object",
"description": "Rate limiting precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLANUTP"
],
"description": "Name of rate limiting precedence item"
}
}
}
}
}
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Get Precedence Profile by profile's ID ¶
GET/v6_1/precedence/{id}
Use this API command to Get Precedence Profile by profile’s ID.
200
Body
{
"name": "precedence-name01",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"vlanPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLAN"
}
],
"rateLimitingPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLANUTP"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the precedence profile",
"minLength": 2,
"maxLength": 32,
"type": "string",
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"vlanPrecedence": {
"type": "array",
"description": "vlan precedence",
"items": {
"type": "object",
"description": "Vlan precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLAN"
],
"description": "Name of the Vlan precedence item"
}
}
}
},
"rateLimitingPrecedence": {
"type": "array",
"description": "rate limiting precedence",
"items": {
"type": "object",
"description": "Rate limiting precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLANUTP"
],
"description": "Name of rate limiting precedence item"
}
}
}
}
}
}
Get Precedence Profile list ¶
GET/v6_1/precedence
Use this API command to Get Precedence Profile list.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "be52f970-e9da-11e6-952e-64006a6a50c6",
"name": "precedence",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"vlanPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLAN"
}
],
"rateLimitingPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLANUTP"
}
]
}
],
"extra": {}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"vlanPrecedence": {
"type": "array",
"description": "vlan precedence",
"items": {
"type": "object",
"description": "Vlan precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLAN"
],
"description": "Name of the Vlan precedence item"
}
}
}
},
"rateLimitingPrecedence": {
"type": "array",
"description": "rate limiting precedence",
"items": {
"type": "object",
"description": "Rate limiting precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLANUTP"
],
"description": "Name of rate limiting precedence item"
}
}
}
}
}
}
}
}
}
Modify Precedence Profile by profile's ID ¶
PATCH/v6_1/precedence/{id}
Use this API command to Modify Precedence Profile by profile’s ID.
Body
{
"name": "precedence-name02",
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"vlanPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLAN"
}
],
"rateLimitingPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLANUTP"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the precedence profile",
"minLength": 2,
"maxLength": 32,
"type": "string",
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"vlanPrecedence": {
"type": "array",
"description": "vlan precedence",
"items": {
"type": "object",
"description": "Vlan precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLAN"
],
"description": "Name of the Vlan precedence item"
}
}
}
},
"rateLimitingPrecedence": {
"type": "array",
"description": "rate limiting precedence",
"items": {
"type": "object",
"description": "Rate limiting precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLANUTP"
],
"description": "Name of rate limiting precedence item"
}
}
}
}
}
}
200
Delete Precedence Profile by profile's ID ¶
DELETE/v6_1/precedence/{id}
Use this API command to Delete Precedence Profile by profile’s ID.
204
Bulk Delete Precedence Profile ¶
DELETE/v6_1/precedence
Use this API command to Bulk Delete Precedence Profile.
Body
{
"idList": [
"d18e44e0-8af5-11e4-8155-000c299b4765",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Query Precedence Profile ¶
POST/v6_1/precedence/query
Use this API command to query Precedence Profile. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "be52f970-e9da-11e6-952e-64006a6a50c6",
"name": "precedence",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"vlanPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLAN"
}
],
"rateLimitingPrecedence": [
{
"priority": 1,
"name": "AAA"
},
{
"priority": 2,
"name": "DEVICE"
},
{
"priority": 3,
"name": "WLANUTP"
}
]
}
],
"extra": {}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the profile",
"type": "string"
},
"name": {
"description": "Name of the profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"vlanPrecedence": {
"type": "array",
"description": "vlan precedence",
"items": {
"type": "object",
"description": "Vlan precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLAN"
],
"description": "Name of the Vlan precedence item"
}
}
}
},
"rateLimitingPrecedence": {
"type": "array",
"description": "rate limiting precedence",
"items": {
"type": "object",
"description": "Rate limiting precedence item",
"additionalProperties": false,
"properties": {
"priority": {
"type": "integer",
"description": "Priority"
},
"name": {
"enum": [
"AAA",
"DEVICE",
"WLANUTP"
],
"description": "Name of rate limiting precedence item"
}
}
}
}
}
}
}
}
}
SCI ¶
Create SCI Profile ¶
POST/v6_1/sci/sciProfile
Use this API command to create sciProfile.
Body
{
"sciProfile": "SCI Profile 1",
"sciSystemId": "SCI System ID 1",
"sciServerHost": "172.17.33.36",
"sciServerPort": "8883",
"sciUser": "user",
"sciPassword": "password"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"sciProfile": {
"description": "Profile name of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciSystemId": {
"description": "SCI system UUID of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciServerHost": {
"description": "SCI server host of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciServerPort": {
"description": "SCI server port of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciUser": {
"description": "SCI user name of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciPassword": {
"description": "SCI password of the SCI profile for SZ/SCI interface",
"type": "string"
}
},
"required": [
"sciProfile",
"sciSystemId",
"sciServerHost",
"sciServerPort",
"sciUser",
"sciPassword"
]
}
200
Body
{
"id": "fd61eb66-d0db-447d-a618-b32d140e80e7"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "UUID of the SCI profile for SZ/SCI interface",
"type": "string"
}
}
}
Retrieve SCI Profile ¶
GET/v6_1/sci/sciProfile/{id}
Use this API command to retrieve sciProfile.
200
Body
{
"id": "fd61eb66-d0db-447d-a618-b32d140e80e7",
"sciPriority": 1,
"sciProfile": "SCI Profile 1",
"sciSystemId": "SCI System ID 1",
"sciServerHost": "172.17.33.36",
"sciServerPort": "8883",
"sciUser": "user",
"sciPassword": "password"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "UUID of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciPriority": {
"description": "Priority of the SCI profile for SZ/SCI interface",
"type": "integer"
},
"sciProfile": {
"description": "Profile name of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciSystemId": {
"description": "SCI system UUID of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciServerHost": {
"description": "SCI server host of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciServerPort": {
"description": "SCI server port of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciUser": {
"description": "SCI user name of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciPassword": {
"description": "SCI password of the SCI profile for SZ/SCI interface",
"type": "string"
}
}
}
Retrieve SCI Profile list ¶
GET/v6_1/sci/sciProfile
Use this API command to retrieve sciProfile list.
200
Body
{
"list": [
{
"id": "fd61eb66-d0db-447d-a618-b32d140e80e7",
"sciPriority": 1,
"sciProfile": "SCI Profile 1",
"sciSystemId": "SCI System ID 1",
"sciServerHost": "172.17.33.36",
"sciServerPort": "8883",
"sciUser": "user",
"sciPassword": "password"
},
{
"id": "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
"sciPriority": 2,
"sciProfile": "SCI Profile 2",
"sciSystemId": "SCI System ID 2",
"sciServerHost": "172.17.33.37",
"sciServerPort": "8883",
"sciUser": "user",
"sciPassword": "password"
}
],
"extra": {
"sciEnabled": "true"
}
}
Schema
{
"type": "object",
"additionalProperties": true,
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "UUID of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciPriority": {
"description": "Priority of the SCI profile for SZ/SCI interface",
"type": "integer"
},
"sciProfile": {
"description": "Profile name of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciSystemId": {
"description": "SCI system UUID of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciServerHost": {
"description": "SCI server host of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciServerPort": {
"description": "SCI server port of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciUser": {
"description": "SCI user name of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciPassword": {
"description": "SCI password of the SCI profile for SZ/SCI interface",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"sciEnabled": {
"description": "SCI password of the SCI profile for SZ/SCI interface",
"type": "boolean"
}
}
}
}
}
Modify SCI Profile ¶
PATCH/v6_1/sci/sciProfile/{id}
Use this API command to modify sciProfile.
Body
{
"sciProfile": "SCI Profile 1",
"sciSystemId": "SCI System ID 1",
"sciServerHost": "172.17.33.36",
"sciServerPort": "8883",
"sciUser": "user",
"sciPassword": "password"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "UUID of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciProfile": {
"description": "Profile name of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciSystemId": {
"description": "SCI system UUID of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciServerHost": {
"description": "SCI server host of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciServerPort": {
"description": "SCI server port of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciUser": {
"description": "SCI user name of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciPassword": {
"description": "SCI password of the SCI profile for SZ/SCI interface",
"type": "string"
}
},
"required": [
"sciProfile",
"sciSystemId",
"sciServerHost",
"sciServerPort",
"sciUser",
"sciPassword"
]
}
200
Modify SCI Priorities ¶
POST/v6_1/sci/sciProfile/sciPriority
Use this API command to modify sciPriorities.
Body
{
"list": [
{
"id": "fd61eb66-d0db-447d-a618-b32d140e80e7",
"sciPriority": 2,
"sciProfile": "SCI Profile 1"
},
{
"id": "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
"sciPriority": 1,
"sciProfile": "SCI Profile 2"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "UUID of the SCI profile for SZ/SCI interface",
"type": "string"
},
"sciPriority": {
"description": "Priority of the SCI profile for SZ/SCI interface",
"type": "integer"
},
"sciProfile": {
"description": "Profile name of the SCI profile for SZ/SCI interface",
"type": "string"
}
},
"required": [
"id",
"sciPriority",
"sciProfile"
]
}
}
}
}
200
Delete SCI Profile ¶
Delete SCI Profile list ¶
DELETE/v6_1/sci/sciProfile
Use this API command to delete sciProfile list.
Body
{
"list": [
{
"id": "fd61eb66-d0db-447d-a618-b32d140e80e7"
},
{
"id": "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "UUID of the SCI profile for SZ/SCI interface",
"type": "string"
}
},
"required": [
"id"
]
}
}
}
}
200
Modify sciEnabled Setting ¶
PATCH/v6_1/sci/sciEnabled
Use this API command to modify SCI settings is enabled or not.
Body
{
"sciEnabled": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"sciEnabled": {
"description": "Is SZ/SCI interface enabled or disabled",
"type": "boolean"
}
},
"required": [
"sciEnabled"
]
}
200
Retrieve SCI Accepted Event Codes ¶
GET/v6_1/sci/sciEventCode
Use this API command to retrieve SciAcceptedEventCodes.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"code": 202,
"type": "clientJoin"
},
{
"code": 204,
"type": "clientDisconnect"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total SCI accepted event code count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more SCI accepted event codes after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first event code returned from the complete event code set",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"description": "SCI accepted event code",
"type": "integer"
},
"type": {
"description": "SCI accepted event type",
"type": "string"
}
}
}
}
}
}
Modify SCI Accepted Event Codes ¶
POST/v6_1/sci/sciEventCode
Use this API command to modify SciAcceptedEventCodes.
Body
{
"sciAcceptedEventCodes": [
202,
204
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"sciAcceptedEventCodes": {
"type": "array",
"items": {
"description": "SCI accepted event code",
"type": "integer"
}
}
},
"required": [
"sciAcceptedEventCodes"
]
}
200
Access Point APP ¶
Retrieve Total AP Count ¶
GET/v6_1/aps/totalCount
Use this API command to retrieve the total AP count within a zone or a domain.
- zoneId
string
(optional)filter AP total count by zone. Default: current logon domain
- domainId
string
(optional)filter AP total count by domain. Default: current logon domain
200
Retrieve AP Summary ¶
GET/v6_1/aps/lineman
Use this API command to retrieve the summary information of an AP. This is used by the Ruckus Wireless AP mobile app.
- 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
- zoneId
string
(optional)filter AP lineman by zone. Default: current login domain
- domainId
string
(optional)filter AP lineman by domain. Default: current login domain
- showAlarm
string
(optional)indicate to show alarm counter. Default: true
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"mac": "00:11:22:33:44:55",
"name": "apName",
"latitude": "22.3",
"longitude": "114",
"location": "location",
"configState": "newConfig",
"alarms": {
"criticalCount": 0,
"majorCount": 1,
"minorCount": 7,
"warningCount": 0
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total AP count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more APs after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first AP returned out of the complete AP list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "MAC address of the AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"name": {
"description": "Name of the AP",
"type": "string"
},
"latitude": {
"description": "Latitude coordinate (in decimal format) of the AP",
"type": "number"
},
"longitude": {
"description": "Longitude coordinate (in decimal format) of the AP",
"type": "number"
},
"configState": {
"description": "State of the AP configuration",
"enum": [
"newConfig",
"fwApplied",
"fwDownloaded",
"fwFailed",
"configApplied",
"completed",
"configFailed"
]
},
"location": {
"description": "Location of the AP. This is a free format text description that indicates the location of the AP.",
"type": "string"
},
"alarms": {
"description": "Alarm counters by severity on the AP",
"type": "object",
"additionalProperties": false,
"properties": {
"criticalCount": {
"description": "Critical alarm count",
"type": "integer"
},
"majorCount": {
"description": "Major alarm count",
"type": "integer"
},
"minorCount": {
"description": "Minor alarm count",
"type": "integer"
},
"warningCount": {
"description": "Warning alarm count",
"type": "integer"
}
}
}
}
}
}
}
}
Wireless Client ¶
Retrieve Total Client Count ¶
GET/v6_1/aps/{apMac}/operational/client/totalCount
Use this API command to retrieve the total client count per AP.
200
Retrieve Client List ¶
GET/v6_1/aps/{apMac}/operational/client
Use this API command to retrieve the client list per AP.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"mac": "3C:A9:F4:0C:85:B0",
"ipAddress": "172.18.116.141",
"ipv6Address": "2001:b030:2516:1a0::5d6e",
"hostName": "SDC-Randall-PC",
"osType": "Windows 7/Vista",
"user": "",
"status": "AUTHORIZED",
"radioId": "0",
"radioMode": null,
"channel": "11",
"wlanId": "1",
"ssid": "client-test",
"snr": "46",
"rssi": "-49",
"rxByteRate": 52,
"txByteRate": 39,
"rxAvgByteRate": 50,
"txAvgByteRate": 30,
"fromClientBytes": 240863,
"toClientBytes": 642897,
"fromClientPkts": 2247,
"toClientPkts": 7678,
"connectedSince": 2600,
"vlan": "1",
"toClientDroppedPkts": 108
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total client count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more clients after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first client returned out of the complete client list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "MAC of the Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"ipAddress": {
"description": "IP address of the Client",
"type": "string"
},
"ipv6Address": {
"description": "IP V6 address of the Client",
"type": "string"
},
"hostName": {
"description": "Host name",
"type": "string"
},
"osType": {
"description": "OS type",
"type": "string"
},
"user": {
"description": "User",
"type": "string"
},
"status": {
"description": "Status",
"type": "string"
},
"radioId": {
"description": "Radio inditifier",
"type": "string"
},
"radioMode": {
"description": "Radio mode",
"type": "string"
},
"channel": {
"description": "Channel",
"type": "string"
},
"wlanId": {
"description": "WLAN inditifier",
"type": "string"
},
"ssid": {
"description": "SSID",
"type": "string"
},
"snr": {
"description": "SNR(dB)",
"type": "string"
},
"rssi": {
"description": "RSSI(dBm)",
"type": "string"
},
"rxByteRate": {
"description": "RX Byte Rate",
"type": "integer"
},
"txByteRate": {
"description": "TX Byte Rate",
"type": "integer"
},
"rxAvgByteRate": {
"description": "RX Avg Byte Rate",
"type": "integer"
},
"txAvgByteRate": {
"description": "TX Avg Byte Rate",
"type": "integer"
},
"fromClientBytes": {
"description": "From client bytes",
"type": "integer"
},
"toClientBytes": {
"description": "To client bytes",
"type": "integer"
},
"fromClientPkts": {
"description": "From client package frames",
"type": "integer"
},
"toClientPkts": {
"description": "To client package frames",
"type": "integer"
},
"connectedSince": {
"description": "Connected since (in milliseconds)",
"type": "integer"
},
"vlan": {
"description": "VLAN id",
"type": "string"
},
"toClientDroppedPkts": {
"description": "To client dropped packages",
"type": "integer"
},
"apTxDataRate": {
"description": "AP Tx Data Rate",
"type": "string"
}
}
}
}
}
}
Deauth client ¶
POST/v6_1/clients/deauth
Use this API command to deauth client.
Body
{
"mac": "E8:99:C4:AD:7C:38",
"apMac": "C0:8A:DE:24:FA:00"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"apMac": {
"description": "AP Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
},
"required": [
"mac",
"apMac"
]
}
204
Disconnect client ¶
POST/v6_1/clients/disconnect
Use this API command to disconnect client.
Body
{
"mac": "E8:99:C4:AD:7C:38",
"apMac": "C0:8A:DE:24:FA:00"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"apMac": {
"description": "AP Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
},
"required": [
"mac",
"apMac"
]
}
204
Bulk disconnect client ¶
POST/v6_1/clients/bulkDisconnect
Use this API command to bulk disconnect client.
Body
{
"clientList": [
{
"apMac": "AB:CD:00:00:00:0E",
"mac": "20:80:00:00:1F:40"
},
{
"apMac": "AB:CD:00:00:00:0D",
"mac": "20:90:00:00:23:28"
}
]
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"clientList": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"apMac": {
"description": "AP Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
},
"required": [
"mac",
"apMac"
]
},
"minItems": 1,
"uniqueItems": true
}
}
}
204
Historical client ¶
POST/v6_1/query/historicalclient
Use this API command to retrive historical client. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": true,
"firstIndex": 0,
"extra": "",
"list": [
{
"sessionStartTime": "1466496511",
"sessionEndTime": "1466496666",
"clientMac": "AA:8A:DE:24:FA:00",
"ipAddress": "192.168.1.100",
"coreNetworkType": "TTG",
"mvnoId": "AT&T",
"apMac": "C0:8A:DE:24:FA:00",
"ssid": "TestSSID",
"txBytes": "26431",
"rxBytes": "52513525",
"txFrames": "2656",
"rxFrames": "154625",
"txDrops": "659",
"rxDrops": "125"
}
]
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for historical client",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"sessionStartTime": {
"description": "Session start time of the client",
"type": "long"
},
"sessionEndTime": {
"description": "Session end time of the client",
"type": "long"
},
"clientMac": {
"description": "Client MAC address",
"type": "string"
},
"ipAddress": {
"description": "Client IP address",
"type": "string"
},
"ipv6Address": {
"description": "Client IPv6 address",
"type": "string"
},
"coreNetworkType": {
"description": "Core network type of the client",
"type": "string"
},
"mvnoName": {
"description": "MVNO name of the client",
"type": "string"
},
"apMac": {
"description": "Client connected AP's MAC address",
"type": "string"
},
"ssid": {
"description": "Client connected SSID name",
"type": "string"
},
"txBytes": {
"description": "Bytes from client",
"type": "long"
},
"rxBytes": {
"description": "Bytes to client",
"type": "long"
},
"txFrames": {
"description": "Bytes from client",
"type": "long"
},
"rxFrames": {
"description": "Bytes to client",
"type": "long"
},
"txDrops": {
"description": "Dropped packets from client",
"type": "long"
},
"rxDrops": {
"description": "Dropped packets to client",
"type": "long"
}
}
}
}
}
}
Query client by wlan name ¶
POST/v6_1/clients/byWlanName/{wlanname}
Use this API command to query client by wlan name.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"apMac": "58:B6:33:37:D4:E0",
"apName": "R710_Box_Up_Pink",
"hostname": "Nolan_DELL_Laptop",
"status": "AUTHORIZED",
"authStatus": "AUTHORIZED",
"alerts": null,
"osType": "Windows 7/Vista",
"ipAddress": "10.11.0.86",
"ipv6Address": "2001:b030:2516:164:7074:3f14:f0d9:c939",
"clientMac": "00:24:D7:89:36:A0",
"ssid": "NolanWPATest",
"txBytes": 2099158501,
"rxBytes": 73731395,
"txRxBytes": 2172889896,
"uplink": 73731395,
"downlink": 2099158501,
"traffic": 2172889896,
"uplinkRate": 131194,
"downlinkRate": 3735157,
"rssi": -47,
"snr": 58,
"radioType": "11a/n/ac",
"vlan": 1,
"channel": 36,
"userName": null,
"authMethod": "Standard+Open",
"encryptionMethod": "WPA2-AES",
"controlPlaneName": "node232",
"dataPlaneName": null,
"rxFrames": 952977,
"txFrames": 1729632,
"txDropDataFrames": 4,
"sessionStartTime": 1487400391000,
"speedflex": 0,
"wlanType": "0",
"zoneId": "d6ad32aa-c400-4005-b9c2-1d5b90e44139",
"zoneVersion": "3.5.0.99.1132"
},
{
"apMac": "74:3E:2B:35:ED:80",
"apName": "R700_ED:80_123",
"hostname": "mit-E5430",
"status": "AUTHORIZED",
"authStatus": "AUTHORIZED",
"alerts": null,
"osType": "Windows 7/Vista",
"ipAddress": "192.168.10.26",
"ipv6Address": "3075:100::d597:4368:1acf:49f3",
"clientMac": "24:77:03:E7:53:D0",
"ssid": "qa-mit-kpi-231",
"txBytes": 8336498864,
"rxBytes": 150640661,
"txRxBytes": 8487139525,
"uplink": 150640661,
"downlink": 8336498864,
"traffic": 8487139525,
"uplinkRate": 5589,
"downlinkRate": 309320,
"rssi": -32,
"snr": 80,
"radioType": "11g/n",
"vlan": 1,
"channel": 11,
"userName": null,
"authMethod": "Standard+Open",
"encryptionMethod": "WPA2-AES",
"controlPlaneName": "node232",
"dataPlaneName": null,
"rxFrames": 2830943,
"txFrames": 5936625,
"txDropDataFrames": 60315,
"sessionStartTime": 1487555453000,
"speedflex": 0,
"wlanType": "0",
"zoneId": "6d6c9cbb-45ba-48e4-a6c9-af28b286a507",
"zoneVersion": "3.5.0.99.1132"
}
]
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for client list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"role": {
"type": "string"
},
"ipv6Address": {
"type": "string"
},
"clientMac": {
"type": "string"
},
"dataPlaneName": {
"type": "string"
},
"channel": {
"type": "integer"
},
"ssid": {
"type": "string"
},
"encryptionMethod": {
"type": "string"
},
"apName": {
"type": "string"
},
"traffic": {
"type": "integer"
},
"uplink": {
"type": "integer"
},
"downlink": {
"type": "integer"
},
"txRxBytes": {
"type": "integer"
},
"txDropDataFrames": {
"type": "integer"
},
"txFrames": {
"type": "integer"
},
"hostname": {
"type": "string"
},
"vlan": {
"type": "integer"
},
"controlPlaneName": {
"type": "string"
},
"rxFrames": {
"type": "integer"
},
"wlanType": {
"type": "string"
},
"osType": {
"type": "string"
},
"speedflex": {
"type": "integer"
},
"rssi": {
"type": "integer"
},
"rxBytes": {
"type": "integer"
},
"ipAddress": {
"type": "string"
},
"sessionStartTime": {
"type": "number"
},
"apMac": {
"type": "string"
},
"userName": {
"type": "string"
},
"alerts": {
"type": "integer"
},
"txBytes": {
"type": "integer"
},
"snr": {
"type": "integer"
},
"authMethod": {
"type": "string"
},
"radioType": {
"type": "string"
},
"status": {
"type": "string"
},
"zoneVersion": {
"type": "string"
},
"authStatus": {
"type": "string"
},
"uplinkRate": {
"type": "integer"
},
"downlinkRate": {
"type": "integer"
},
"zoneId": {
"type": "string"
},
"bssid": {
"type": "string"
}
}
}
}
}
}
Block Client ¶
Create Block Client ¶
POST/v6_1/blockClient/{zoneId}
Create a new Block Client.
Body
{
"mac": "AA:BB:CC:DD:EE:FF",
"description": ""
}
Schema
{
"type": "object",
"properties": {
"mac": {
"description": "MAC of the Block Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId": {
"description": "Zone Id of the Block Client for clone in System Domain",
"type": "string"
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"mac"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create Block Client by AP MAC ¶
POST/v6_1/blockClient/byApMac/{apMac}
Create a new Block Client by AP MAC.
Body
{
"mac": "AA:BB:CC:DD:EE:FF",
"description": ""
}
Schema
{
"type": "object",
"properties": {
"mac": {
"description": "MAC of the Block Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId": {
"description": "Zone Id of the Block Client for clone in System Domain",
"type": "string"
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"mac"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create Block Clients ¶
POST/v6_1/blockClient
Create new Block Clients by list.
Body
{
"blockClientList": [
{
"mac": "27:60:00:01:28:E0",
"apMac": "AB:CD:00:00:00:14"
},
{
"mac": "27:70:00:01:2C:C8",
"apMac": "AB:CD:00:00:00:13"
}
],
"description": ""
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"blockClientList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mac": {
"description": "MAC of the Block Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId": {
"description": "Zone Id of the Block Client for clone in System Domain",
"type": "string"
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
},
"apMac": {
"description": "MAC of the AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
},
"required": [
"mac",
"apMac"
]
}
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
201
Body
[
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
]
Schema
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
}
Retrieve List ¶
POST/v6_1/blockClient/query
Retrieve a list of Block Client. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "3cc54201-6523-11e6-ab64-24c9a13f96c1",
"mac": "AA:BB:CC:DD:EE:FF",
"description": "des",
"modifiedDateTime": 1471511269921,
"modifierUsername": "admin"
}
]
}
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 profile",
"type": "string"
},
"mac": {
"description": "MAC of the Block Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId": {
"description": "Zone Id of the Block Client for clone in System Domain",
"type": "string"
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
},
"modifiedDateTime": {
"description": "Date blocked of the Block Client",
"type": "integer"
},
"modifierUsername": {
"description": "Modifier blocked of the Block Client",
"type": "string"
}
}
}
}
}
}
Retrieve List ¶
GET/v6_1/blockClient/byZone/{zoneId}
Retrieve a list of Block Client.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "3cc54201-6523-11e6-ab64-24c9a13f96c1",
"mac": "AA:BB:CC:DD:EE:FF",
"description": "des",
"modifiedDateTime": 1471511269921,
"modifierUsername": "admin"
}
]
}
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 profile",
"type": "string"
},
"mac": {
"description": "MAC of the Block Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId": {
"description": "Zone Id of the Block Client for clone in System Domain",
"type": "string"
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
},
"modifiedDateTime": {
"description": "Date blocked of the Block Client",
"type": "integer"
},
"modifierUsername": {
"description": "Modifier blocked of the Block Client",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/blockClient/{id}
Retrieve a Block Client.
200
Body
{
"mac": "AA:BB:CC:DD:EE:FF",
"description": ""
}
Schema
{
"type": "object",
"properties": {
"mac": {
"description": "MAC of the Block Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId": {
"description": "Zone Id of the Block Client for clone in System Domain",
"type": "string"
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"mac"
]
}
Modify ¶
PUT/v6_1/blockClient/{id}
Modify a specific Block Client basic.
Body
{
"mac": "AA:BB:CC:DD:EE:FF",
"description": "des"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "MAC of the Block Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
204
Modify ¶
PATCH/v6_1/blockClient/{id}
Modify a specific Block Client basic.
Body
{
"mac": "AA:BB:CC:DD:EE:FF",
"description": "des"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "MAC of the Block Client",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"description": {
"description": "Description of the Block Client",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
204
Delete ¶
DELETE/v6_1/blockClient
Delete Block Client List.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Mark Rogue ¶
Mark Known Rogue ¶
POST/v6_1/rogue/markKnown
Mark a rogue AP as know.
Body
{
"rogueMacList": "E0:11:12:23:F2:22"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rogueMacList": {
"type": "array",
"description": "rogue mac list",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
204
Mark Malicious Rogue ¶
POST/v6_1/rogue/markMalicious
Mark a rogue AP as malicious.
Body
{
"rogueMacList": "E0:11:12:23:F2:22"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rogueMacList": {
"type": "array",
"description": "rogue mac list",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
204
Mark Ignore Rogue ¶
POST/v6_1/rogue/markIgnore
Mark a rogue AP as ignore.
Body
{
"rogueMacList": "E0:11:12:23:F2:22"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rogueMacList": {
"type": "array",
"description": "rogue mac list",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
204
Mark Rogue to Rogue ¶
POST/v6_1/rogue/markRogue
Mark a rogue AP as rogue.
Body
{
"rogueMacList": "E0:11:12:23:F2:22"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rogueMacList": {
"type": "array",
"description": "rogue mac list",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
204
Unmark Rogue ¶
POST/v6_1/rogue/unMark
Use this API command to remove the manual admin classification marking.
Body
{
"rogueMacList": "E0:11:12:23:F2:22"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rogueMacList": {
"type": "array",
"description": "rogue mac list",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
204
Get known Rogue ¶
GET/v6_1/rogue/markKnown
Get Known Rogue AP list.
200
Body
{
"rogueMacList": "E0:11:12:23:F2:22"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rogueMacList": {
"type": "array",
"description": "rogue mac list",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
LWAPP TO SCG ¶
Get Lwapp Config ¶
GET/v6_1/lwapp2scg
Use this API command to retrieve Lwapp Config.
200
Body
{
"policy": "DENY_ALL",
"pasvMaxPort": null,
"pasvMinPort": null,
"acl": "null",
"apList": [],
"natIpTranslation": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"policy": {
"description": "policy of the lwapp",
"enum": [
"DENY",
"ACCEPT",
"DENY_ALL",
"ACCEPT_ALL"
]
},
"pasvMaxPort": {
"description": "pasvMaxPort of the lwapp",
"type": "integer",
"minimum": 16384,
"maximum": 65000
},
"pasvMinPort": {
"description": "pasvMinPort of the lwapp",
"type": "integer",
"minimum": 16384,
"maximum": 65000
},
"apList": {
"description": "accessPoint List of the lwapp",
"type": "array",
"items": {
"description": "AP MAC Address or AP Serial Number",
"type": "string"
}
},
"acl": {
"description": "acl of the lwapp",
"type": "string"
},
"natIpTranslation": {
"description": "natIpTranslation of the lwapp",
"type": "boolean"
}
}
}
Modify ¶
PATCH/v6_1/lwapp2scg
Use this API command to modify the basic information of the Lwapp Config.
Body
{
"policy": "ACCEPT",
"pasvMaxPort": 65000,
"pasvMinPort": 16384,
"apList": [
"12345",
"00:1D:2E:45:10:00"
],
"natIpTranslation": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"policy": {
"description": "policy of the lwapp",
"enum": [
"DENY",
"ACCEPT",
"DENY_ALL",
"ACCEPT_ALL"
]
},
"pasvMaxPort": {
"description": "pasvMaxPort of the lwapp",
"type": "integer",
"minimum": 16384,
"maximum": 65000
},
"pasvMinPort": {
"description": "pasvMinPort of the lwapp",
"type": "integer",
"minimum": 16384,
"maximum": 65000
},
"apList": {
"description": "accessPoint List of the lwapp",
"type": "array",
"items": {
"description": "AP MAC Address or AP Serial Number",
"type": "string"
}
},
"natIpTranslation": {
"description": "natIpTranslation of the lwapp",
"type": "boolean"
}
}
}
204
Modify ApList ¶
PATCH/v6_1/lwapp2scg/apList
Use this API command to modify the apList of the Lwapp Config.
Body
[
"12345",
"00:1D:2E:45:10:00"
]
Schema
{
"description": "accessPoint List of the lwapp",
"type": "array",
"items": {
"description": "AP MAC Address or AP Serial Number",
"type": "string"
}
}
204
Wired Client ¶
Query Wired Clients ¶
POST/v6_1/query/wiredclient
Query wired clients with specified filters Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"apMac": "58:B6:33:37:D4:E0",
"apName": "R710_Box_Up_Pink",
"apEthID": 2,
"hostname": "Nolan_DELL_Laptop",
"authStatus": "AUTHORIZED",
"osType": "Windows 7/Vista",
"ipAddress": "10.11.0.86",
"ipv6Address": "2001:b030:2516:164:7074:3f14:f0d9:c939",
"clientMac": "00:24:D7:89:36:A0",
"txBytes": 2099158501,
"rxBytes": 73731395,
"txRxBytes": 2172889896,
"uplink": 73731395,
"downlink": 2099158501,
"traffic": 2172889896,
"vlan": 1,
"userName": "Admin",
"rxFrames": 952977,
"txFrames": 1729632,
"txRetry": 952977,
"sessionStartTime": 1487400391000,
"wlanType": null
}
]
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for client list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"apName": {
"type": "string"
},
"ipv6Address": {
"type": "string"
},
"clientMac": {
"type": "string"
},
"traffic": {
"type": "integer"
},
"uplink": {
"type": "integer"
},
"downlink": {
"type": "integer"
},
"txRxBytes": {
"type": "integer"
},
"txRetry": {
"type": "integer"
},
"txFrames": {
"type": "integer"
},
"hostname": {
"type": "string"
},
"vlan": {
"type": "integer"
},
"rxFrames": {
"type": "integer"
},
"wlanType": {
"type": "string"
},
"osType": {
"type": "string"
},
"rxBytes": {
"type": "integer"
},
"ipAddress": {
"type": "string"
},
"sessionStartTime": {
"type": "number"
},
"apMac": {
"type": "string"
},
"userName": {
"type": "string"
},
"txBytes": {
"type": "integer"
},
"authStatus": {
"type": "string"
},
"apEthID": {
"type": "integer"
}
}
}
}
}
}
Bulk deauth wired client ¶
POST/v6_1/clients/bulkDeauth
Use this API command to bulk deauth wired client.
Body
{
"clientList": [
{
"apMac": "AB:CD:00:00:00:0E",
"mac": "20:80:00:00:1F:40"
},
{
"apMac": "AB:CD:00:00:00:0D",
"mac": "20:90:00:00:23:28"
}
]
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"clientList": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "Client Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"apMac": {
"description": "AP Mac",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
},
"required": [
"mac",
"apMac"
]
},
"minItems": 1,
"uniqueItems": true
}
}
}
204
System ¶
System Summary ¶
GET/v6_1/controller
Use this API command to retrieve the system summary.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "b42be2c8-71bf-465a-8fd2-3911dcf885e4",
"model": "SCG200",
"description": "gui96-scg200-vm",
"hostName": "gui96-scg200-vm",
"mac": "00:0C:29:B1:34:69",
"serialNumber": "00000096",
"clusterRole": "Follower",
"controlNatIp": null,
"uptimeInSec": 165561,
"name": "gui96-scg200-vm-C",
"version": "3.0.0.0.211",
"cpVersion": "3.0.0.0.543",
"dpVersion": "3.0.0.0.56",
"apVersion": "3.0.0.0.125",
"controlIp": "172.18.114.29",
"clusterIp": "172.18.114.32",
"managementIp": "172.18.114.96"
}
]
}
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 controller",
"type": "string"
},
"model": {
"description": "Product model",
"type": "string"
},
"description": {
"description": "Description of the controller",
"type": "string"
},
"hostName": {
"description": "Host name of the controller",
"type": "string"
},
"mac": {
"description": "MAC address of the controller",
"type": "string"
},
"serialNumber": {
"description": "Serial number of the controller",
"type": "string"
},
"clusterRole": {
"description": "Indicator the role of the controller",
"type": "string"
},
"controlNatIp": {
"description": "Control NAT IP address settings",
"type": "string"
},
"uptimeInSec": {
"description": "Uptime (in seconds) of the controller",
"type": "integer"
},
"name": {
"description": "Name of the controller",
"type": "string"
},
"version": {
"description": "SCG version",
"type": "string"
},
"cpVersion": {
"description": "Control plane version",
"type": "string"
},
"dpVersion": {
"description": "Data plane version",
"type": "string"
},
"apVersion": {
"description": "AP version",
"type": "string"
},
"controlIp": {
"description": "Control IP",
"type": "string"
},
"clusterIp": {
"description": "Cluster IP",
"type": "string"
},
"managementIp": {
"description": "Management IP",
"type": "string"
},
"controlIpv6": {
"description": "Control IPv6",
"type": "string"
},
"clusterIpv6": {
"description": "Cluster IPv6",
"type": "string"
},
"managementIpv6": {
"description": "Management IPv6",
"type": "string"
}
}
}
}
}
}
AP Models ¶
GET/v6_1/system/apmodels
Use this API command to retrieve support AP models for the current installed SZ version’s default AP firmware.
200
System Statistics ¶
GET/v6_1/controller/{id}/statistics
Use this API command to retrieve the system statistics.
- interval
string
(optional)Interval, only valid of (QUARTER, HOUR, DAY). Default: QUARTER
- size
number
(optional)Size, list size to response. Default: 32
200
Body
[
{
"cpId": "f214c803-c88f-40f8-83d5-a6e37a9840de",
"timestamp": 1419877800000,
"cpu": {
"percent": 8.776667,
"maxPercent": 32.85,
"minPercent": 3.78
},
"disk": {
"total": 71417208,
"free": 70844653,
"maxFree": 70845604,
"minFree": 70843696
},
"memory": {
"percent": 77.59,
"maxPercent": 77.61,
"minPercent": 77.58
},
"control": {
"rxBps": 898,
"rxBpsMax": 9160,
"rxBpsMin": 192,
"rxBytes": 101038,
"rxDropped": 0,
"rxPackets": 761,
"txBps": 293,
"txBpsMax": 4771.2,
"txBpsMin": 0,
"txBytes": 32964,
"txDropped": 0,
"txPackets": 209
},
"cluster": {
"rxBps": 24,
"rxBpsMax": 2080,
"rxBpsMin": 0,
"rxBytes": 2794,
"rxDropped": 0,
"rxPackets": 10,
"txBps": 6,
"txBpsMax": 614.4,
"txBpsMin": 0,
"txBytes": 768,
"txDropped": 0,
"txPackets": 4
},
"management": {
"rxBps": 216,
"rxBpsMax": 25016,
"rxBpsMin": 0,
"rxBytes": 24328,
"rxDropped": 0,
"rxPackets": 146,
"txBps": 139,
"txBpsMax": 15129.6,
"txBpsMin": 0,
"txBytes": 15641,
"txDropped": 0,
"txPackets": 108
},
"port0": {
"rxBps": 867,
"rxBpsMax": 9064,
"rxBpsMin": 192,
"rxBytes": 97557,
"rxDropped": 0,
"rxPackets": 732,
"txBps": 293,
"txBpsMax": 4771.2,
"txBpsMin": 0,
"txBytes": 32964,
"txDropped": 0,
"txPackets": 209
},
"port1": {
"rxBps": 13,
"rxBpsMax": 1040,
"rxBpsMin": 0,
"rxBytes": 1494,
"rxDropped": 0,
"rxPackets": 6,
"txBps": 6,
"txBpsMax": 614.4,
"txBpsMin": 0,
"txBytes": 768,
"txDropped": 0,
"txPackets": 4
},
"port2": {
"rxBps": 216,
"rxBpsMax": 25016,
"rxBpsMin": 0,
"rxBytes": 24328,
"rxDropped": 0,
"rxPackets": 146,
"txBps": 139,
"txBpsMax": 15129.6,
"txBpsMin": 0,
"txBytes": 15641,
"txDropped": 0,
"txPackets": 108
},
"port3": {
"rxBps": 30,
"rxBpsMax": 1248,
"rxBpsMin": 0,
"rxBytes": 3481,
"rxDropped": 0,
"rxPackets": 29,
"txBps": 0,
"txBpsMax": 0,
"txBpsMin": 0,
"txBytes": 0,
"txDropped": 0,
"txPackets": 0
},
"port4": {
"rxBps": 11,
"rxBpsMax": 1040,
"rxBpsMin": 0,
"rxBytes": 1300,
"rxDropped": 0,
"rxPackets": 4,
"txBps": 0,
"txBpsMax": 0,
"txBpsMin": 0,
"txBytes": 0,
"txDropped": 0,
"txPackets": 0
},
"port5": {
"rxBps": 0,
"rxBpsMax": 0,
"rxBpsMin": 0,
"rxBytes": 0,
"rxDropped": 0,
"rxPackets": 0,
"txBps": 0,
"txBpsMax": 0,
"txBpsMin": 0,
"txBytes": 0,
"txDropped": 0,
"txPackets": 0
}
}
]
Schema
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"description": "timestamp",
"type": "number"
},
"cpu": {
"type": "object",
"additionalProperties": false,
"properties": {
"percent": {
"description": "percent",
"type": "number"
},
"maxPercent": {
"description": "maxPercent",
"type": "number"
},
"minPercent": {
"description": "minPercent",
"type": "number"
}
}
},
"disk": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"description": "total",
"type": "number"
},
"free": {
"description": "free",
"type": "number"
},
"maxFree": {
"description": "maxFree",
"type": "number"
},
"minFree": {
"description": "minFree",
"type": "number"
}
}
},
"memory": {
"type": "object",
"additionalProperties": false,
"properties": {
"percent": {
"description": "percent",
"type": "number"
},
"maxPercent": {
"description": "maxPercent",
"type": "number"
},
"minPercent": {
"description": "minPercent",
"type": "number"
}
}
},
"port0": {
"description": "port0",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
},
"port1": {
"description": "port1",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
},
"port2": {
"description": "port2",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
},
"port3": {
"description": "port3",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
},
"port4": {
"description": "port4",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
},
"port5": {
"description": "port5",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
},
"control": {
"description": "control",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
},
"cluster": {
"description": "cluster",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
},
"management": {
"description": "management",
"type": "object",
"additionalProperties": false,
"properties": {
"rxBps": {
"description": "rxBps",
"type": "number"
},
"rxBpsMax": {
"description": "rxBpsMax",
"type": "number"
},
"rxBpsMin": {
"description": "rxBpsMin",
"type": "number"
},
"rxBytes": {
"description": "rxBytes",
"type": "number"
},
"rxDropped": {
"description": "rxDropped",
"type": "number"
},
"rxPackets": {
"description": "rxPackets",
"type": "number"
},
"txBps": {
"description": "txBps",
"type": "number"
},
"txBpsMax": {
"description": "txBpsMax",
"type": "number"
},
"txBpsMin": {
"description": "txBpsMin",
"type": "number"
},
"txBytes": {
"description": "txBytes",
"type": "number"
},
"txDropped": {
"description": "txDropped",
"type": "number"
},
"txPackets": {
"description": "txPackets",
"type": "number"
}
}
}
}
}
}
System Inventory ¶
GET/v6_1/system/inventory
Use this API command to retrieve the system inventory with current logon user domain.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"zoneId": "1690614e-1c1f-4fe8-9144-24ccf28d83c4",
"zoneName": "api-test-zone",
"meshSSID": null,
"totalAPs": 0,
"discoveryAPs": 0,
"provisionedAPs": 0,
"connectedAPs": 0,
"disconnectedAPs": 0,
"rebootingAPs": 0,
"connectedRootAPs": 0,
"disconnectedRootAPs": 0,
"rebootingRootAPs": 0,
"connectedMeshAPs": 0,
"disconnectedMeshAPs": 0,
"rebootingMeshAPs": 0,
"connectedeMeshAPs": 0,
"disconnectedeMeshAPs": 0,
"rebootingeMeshAPs": 0,
"connectedDownMeshAPs": 0,
"disconnectedDownMeshAPs": 0,
"rebootingDownMeshAPs": 0,
"connectedMeshDisabledAPs": 0,
"disconnectedMeshDisabledAPs": 0,
"clients": 0
},
{
"zoneId": "b4187899-38ae-4ace-8e40-0bc444455156",
"zoneName": "Staging Zone",
"meshSSID": null,
"totalAPs": 1,
"discoveryAPs": 0,
"provisionedAPs": 0,
"connectedAPs": 1,
"disconnectedAPs": 0,
"rebootingAPs": 0,
"connectedRootAPs": 0,
"disconnectedRootAPs": 0,
"rebootingRootAPs": 0,
"connectedMeshAPs": 0,
"disconnectedMeshAPs": 0,
"rebootingMeshAPs": 0,
"connectedeMeshAPs": 0,
"disconnectedeMeshAPs": 0,
"rebootingeMeshAPs": 0,
"connectedDownMeshAPs": 0,
"disconnectedDownMeshAPs": 0,
"rebootingDownMeshAPs": 0,
"connectedMeshDisabledAPs": 1,
"disconnectedMeshDisabledAPs": 0,
"clients": 0
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array"
}
}
}
Modify CAPTCHA ¶
PATCH/v6_1/system/captcha
Use this API command to modify the CAPTCHA setting.
Body
{
"captchaEnabled": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"captchaEnabled": {
"description": "Captcha setting",
"type": "boolean"
}
}
}
204
Retrieve CAPTCHA ¶
GET/v6_1/system/captcha
Use this API command to retrieve the CAPTCHA setting.
200
Body
{
"captchaEnabled": false
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"captchaEnabled": {
"description": "Captcha setting",
"type": "boolean"
}
}
}
Retrieve NBI ¶
GET/v6_1/system/nbi
Use this API command to retrieve user information by Northbound Portal Interface.
- domainId
string
(optional)Domain ID.
200
Body
{
"userName": "admin",
"password": "admin!234"
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "User name of the Northbound Interface",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"password" : {
"description" : "Password of the Northbound Interface",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
}
}
Modify NBI Basic ¶
PATCH/v6_1/system/nbi
Use this API command to modify the user information by Northbound Portal Interface.
- domainId
string
(optional)Domain ID.
Body
{
"userName": "admin",
"password": "admin!234"
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "User name of the Northbound Interface",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"password" : {
"description" : "Password of the Northbound Interface",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
}
}
204
Disable NBI ¶
DELETE/v6_1/system/nbi
Use this API command to disable the user information by Northbound Portal Interface.
- domainId
string
(optional)Domain ID.
204
Decrease AP routine status interval ¶
POST/v6_1/system/apRoutineStatusInterval/speedup
Use this API command to set AP routine status interval setting to 180 seconds.
204
Increase AP routine status interval ¶
POST/v6_1/system/apRoutineStatusInterval/slowdown
Use this API command to set AP routine status interval setting to 900 seconds.
204
Get AP routine status interval setting ¶
GET/v6_1/system/apRoutineStatusInterval
Use this API command to get AP routine status interval setting.
200
Body
{
"apRoutineStatusInterval": 90
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apRoutineStatusInterval": {
"type": "integer"
}
}
}
Get AP recovery setting ¶
GET/v6_1/system/ap_recovery
Use this API command to get system level ap recovery ssid information.
200
Body
{
"enabled": true,
"rsm": "12345678"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "enable AP recovery mode",
"type": "boolean"
},
"rsm": {
"description": "RSM key",
"type": "string"
}
}
}
Modify AP recovery setting ¶
POST/v6_1/system/ap_recovery
Use this API command to patch system level ap recovery ssid.
Body
{
"enabled": true,
"rsm": "12345678"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "enable AP recovery mode",
"type": "boolean"
},
"rsm": {
"description": "RSM key",
"type": "string"
}
}
}
204
Retrieve System Time ¶
GET/v6_1/system/systemTime
Retrieve System Time Setting.
200
Body
{
"currentSystemTimeString": "2017-06-08 15:11:25 CST",
"currentSystemTimeUTCString": "2017-06-08 07:11:25 UTC",
"ntpServer": "ntp.ruckuswireless.com",
"timezone": "Asia/Taipei"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"currentSystemTimeString": {
"description": "System Time",
"type": "string"
},
"currentSystemTimeUTCString": {
"description": "System UTC Time",
"type": "string"
},
"ntpServer": {
"description": "NtpServer address",
"type": "string"
},
"timezone": {
"description": "System defined time zone, please refer to the “Overview > Time Zone” list",
"type": "string"
}
}
}
Modify System Time ¶
PATCH/v6_1/system/systemTime
Modify System Time Setting.
Body
{
"ntpServer": "ntp.ruckuswireless.com",
"timezone": "Asia/Taipei"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ntpServer": {
"description": "NtpServer address",
"type": "string"
},
"timezone": {
"description": "System defined time zone, please refer to the “Overview > Time Zone” list",
"type": "string"
}
}
}
204
Get Settings of System ¶
GET/v6_1/system
Use this API command to get settings of system. Currently, Only can get settings about AP number limit.
200
Body
{
"apNumberLimitEnabled": true,
"apNumberLimitSettingsOfDomain": [
{
"domainId": "0a782052-96d5-738b-afce-123deeeswfgf",
"domainName": "SystemAdmin",
"numberLimit": 1000,
"shared": false
},
{
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"domainName": "domain111",
"numberLimit": 123,
"shared": false
}
],
"apNumberLimitSettingsOfZone": [
{
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"domainName": "domain111",
"zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
"zoneName": "zone11",
"numberLimit": 123,
"shared": true
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apNumberLimitEnabled": {
"description": "Enabled AP number limit feature or not",
"type": "boolean"
},
"apNumberLimitSettingsOfDomain": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Domain Id",
"type": "string"
},
"domainName": {
"description": "Domain Name",
"type": "string"
},
"numberLimit": {
"description": "Number of Limit",
"type": "number"
},
"shared": {
"description": "Share mode",
"type": "boolean"
}
}
}
},
"apNumberLimitSettingsOfZone": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Admin Domain Id",
"type": "string"
},
"domainName": {
"description": "Admin Domain Name",
"type": "string"
},
"zoneId": {
"description": "Zone Id",
"type": "string"
},
"zoneName": {
"description": "Zone Name",
"type": "string"
},
"numberLimit": {
"description": "Number of Limit",
"type": "number"
},
"shared": {
"description": "Share mode",
"type": "boolean"
}
}
}
}
}
}
Query Settings of System ¶
POST/v6_1/system/query
Use this API command to query settings of system. Currently, Only can get settings about AP number limit by query criteria with domain and zone filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"apNumberLimitEnabled": true,
"apNumberLimitSettingsOfDomain": [
{
"domainId": "0a782052-96d5-738b-afce-123deeeswfgf",
"domainName": "SystemAdmin",
"numberLimit": 1000,
"shared": false
},
{
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"domainName": "domain111",
"numberLimit": 123,
"shared": false
}
],
"apNumberLimitSettingsOfZone": [
{
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"domainName": "domain111",
"zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
"zoneName": "zone11",
"numberLimit": 123,
"shared": true
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apNumberLimitEnabled": {
"description": "Enabled AP number limit feature or not",
"type": "boolean"
},
"apNumberLimitSettingsOfDomain": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Domain Id",
"type": "string"
},
"domainName": {
"description": "Domain Name",
"type": "string"
},
"numberLimit": {
"description": "Number of Limit",
"type": "number"
},
"shared": {
"description": "Share mode",
"type": "boolean"
}
}
}
},
"apNumberLimitSettingsOfZone": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Admin Domain Id",
"type": "string"
},
"domainName": {
"description": "Admin Domain Name",
"type": "string"
},
"zoneId": {
"description": "Zone Id",
"type": "string"
},
"zoneName": {
"description": "Zone Name",
"type": "string"
},
"numberLimit": {
"description": "Number of Limit",
"type": "number"
},
"shared": {
"description": "Share mode",
"type": "boolean"
}
}
}
}
}
}
Modify Settings of System ¶
PATCH/v6_1/system
Use this API command to modify settings of system. Currently, Only can modify settings about AP number limit by query criteria with domain and zone filters.
Body
{
"apNumberLimitEnabled": true,
"apNumberLimitSettingsOfDomain": [
{
"domainId": "0a782052-96d5-738b-afce-123deeeswfgf",
"numberLimit": 1000,
"shared": false
},
{
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"numberLimit": 123,
"shared": false
}
],
"apNumberLimitSettingsOfZone": [
{
"domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
"zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
"numberLimit": 123,
"shared": true
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apNumberLimitEnabled": {
"description": "system.saveSystemSettings.properties.apNumberLimitEnabled.description",
"type": "boolean"
},
"apNumberLimitSettingsOfDomain": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "system.saveApNumberLimitSettingOfDomain.properties.domainId.description",
"type": "string"
},
"numberLimit": {
"description": "system.saveApNumberLimitSettingOfDomain.properties.numberLimit.description",
"type": "number"
},
"shared": {
"description": "system.saveApNumberLimitSettingOfDomain.properties.shared.description",
"type": "boolean"
}
},
"required": [
"domainId",
"numberLimit",
"shared"
]
}
},
"apNumberLimitSettingsOfZone": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "system.saveApNumberLimitSettingOfZone.properties.domainId.description",
"type": "string"
},
"zoneId": {
"description": "system.saveApNumberLimitSettingOfZone.properties.zoneId.description",
"type": "string"
},
"numberLimit": {
"description": "system.saveApNumberLimitSettingOfZone.properties.numberLimit.description",
"type": "number"
},
"shared": {
"description": "system.saveApNumberLimitSettingOfZone.properties.shared.description",
"type": "boolean"
}
},
"required": [
"domainId",
"zoneId",
"numberLimit",
"shared"
]
}
}
}
}
204
Test AAA Server ¶
Test AAA ¶
POST/v6_1/system/aaa/test
Use this API command to test AAA server.
Body
{
"serverType": "GLOBAL",
"aaaType": "RADIUS",
"aaaServer": {
"name": "apiAAAServer"
},
"userName": "admin",
"password": "admin!234",
"authProtocol": "CHAP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"serverType": {
"description": "Radius server type.",
"enum": [
"ADMIN",
"GLOBAL",
"ZONE"
]
},
"aaaType": {
"description": "Authentication/Accounting service protocol. RADIUS for Radius, AD and LDAP. RADIUSAcct for RADIUS Accounting",
"enum": [
"RADIUS",
"RADIUSAcct"
]
},
"aaaServer": {
"description": "AAA server id or name",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"userName": {
"description": "User name",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"authProtocol": {
"description": "Authentication protocol",
"enum": [
"PAP",
"CHAP"
],
"default": "PAP"
}
},
"required": [
"aaaServer",
"userName",
"password"
]
}
200
Body
{
"primaryServer": "Success! Groups associated with this user are Student. The user will be assigned a role of SZ-Student.",
"secondaryServer": "Failed! Reason: Timeout: No Response from RADIUS Server"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"primaryServer": {
"description": "Primary server test result",
"type": "string"
},
"secondaryServer": {
"description": "Secondary server test result",
"type": "string"
}
}
}
SNMP Agent ¶
Retrieve SNMP Agent ¶
GET/v6_1/system/snmpAgent
Retrieve SNMP Agent sertting.
200
Body
{
"snmpNotificationEnabled": false,
"snmpV2Agent": [
{
"communityName": "communityName",
"readEnabled": false,
"writeEnabled": false,
"notificationEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "111.11.11.112",
"port": 1
},
{
"address": "111.11.11.114",
"port": 162
},
{
"address": "111.11.11.114",
"port": 162
}
]
}
],
"snmpV3Agent": [
{
"userName": "bbb",
"authProtocol": "SHA",
"authPassword": "authPassword",
"readEnabled": true,
"writeEnabled": true,
"notificationEnabled": false
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"snmpNotificationEnabled": {
"description": "Enable SNMP Notifications Globally (If SNMP Notification is disabled globally, no Notification message is sent out.)",
"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 V2 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": [
"MD5",
"SHA"
]
},
"authPassword": {
"description": "authPassword of the SNMP User.",
"type": "string",
"minLength": 8
},
"privProtocol": {
"description": "privProtocol of the SNMP User.",
"enum": [
"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"
]
}
}
}
}
Modify SNMP Agent ¶
PUT/v6_1/system/snmpAgent
Modify syslog server setting.
Body
{
"snmpNotificationEnabled": true,
"snmpV2Agent": [
{
"communityName": "aaa",
"readEnabled": false,
"writeEnabled": false,
"notificationEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "111.11.11.112",
"port": 1
},
{
"address": "111.11.11.114",
"port": 162
},
{
"address": "111.11.11.114",
"port": 162
}
]
}
],
"snmpV3Agent": [
{
"userName": "userName",
"authProtocol": "SHA",
"authPassword": "authPassword",
"privProtocol": "DES",
"privPassword": "privPassword",
"readEnabled": true,
"writeEnabled": true,
"notificationEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "111.11.11.112",
"port": 1
},
{
"address": "111.11.11.114",
"port": 162
},
{
"address": "111.11.11.114",
"port": 162
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"snmpNotificationEnabled": {
"description": "Enable SNMP Notifications Globally (If SNMP Notification is disabled globally, no Notification message is sent out.)",
"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 V2 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": [
"MD5",
"SHA"
]
},
"authPassword": {
"description": "authPassword of the SNMP User.",
"type": "string",
"minLength": 8
},
"privProtocol": {
"description": "privProtocol of the SNMP User.",
"enum": [
"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"
]
}
}
},
"required": [
"snmpNotificationEnabled"
]
}
204
Domain ¶
Retrieve List - Deprecated ¶
GET/v6_0/rkszones/domains
Use this API command to retrieve a list of domain under Administration Domain.
Deprecated : this URI will be deprecated after Version: v6_0, not support.For the alternative URI, please refer to the “Retrieve List” section of the category “Domain”.
- 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
- recursively
string
(optional)Get domain list recursively.
- includeSelf
string
(optional)Get domain list include Self.
- excludeRegularDomain
string
(optional)
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "domainUUID",
"name": "testDomain_1",
"domainType": "REGULAR",
"description": null,
"createdBy": "admin",
"createDatetime": "2017/05/03 10:15:01",
"parentDomainId": "parentDomainUUId",
"zoneCount": 0,
"subDomainCount": 0,
"administratorCount": 0,
"apCount": 0
}
]
}
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 domain",
"type": "string"
},
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"type": "string"
},
"description": {
"description": "Description of the domain",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createdBy": {
"description": "Created by",
"type": "string"
},
"createDatetime": {
"description": "Created by",
"type": "string"
},
"zoneCount": {
"description": "# of Zones",
"type": "Integer"
},
"subDomainCount": {
"description": "# of Subdomains",
"type": "integer"
},
"administratorCount": {
"description": "# of Subdomains",
"type": "integer"
},
"apCount": {
"description": "# of Subdomains",
"type": "integer"
},
"parentDomainId": {
"description": "Parent Domain Id",
"type": "string"
}
}
}
}
}
}
Retrieve List ¶
GET/v6_1/domains
Use this API command to retrieve a list of domain under Administration Domain.
- 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
- recursively
string
(optional)Get domain list recursively.
- includeSelf
string
(optional)Get domain list include Self.
- excludeRegularDomain
string
(optional)
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "domainUUID",
"name": "testDomain_1",
"domainType": "REGULAR",
"description": null,
"createdBy": "admin",
"createDatetime": "2017/05/03 10:15:01",
"parentDomainId": "parentDomainUUId",
"zoneCount": 0,
"subDomainCount": 0,
"administratorCount": 0,
"apCount": 0
}
]
}
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 domain",
"type": "string"
},
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"type": "string"
},
"description": {
"description": "Description of the domain",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createdBy": {
"description": "Created by",
"type": "string"
},
"createDatetime": {
"description": "Created by",
"type": "string"
},
"zoneCount": {
"description": "# of Zones",
"type": "Integer"
},
"subDomainCount": {
"description": "# of Subdomains",
"type": "integer"
},
"administratorCount": {
"description": "# of Subdomains",
"type": "integer"
},
"apCount": {
"description": "# of Subdomains",
"type": "integer"
},
"parentDomainId": {
"description": "Parent Domain Id",
"type": "string"
}
}
}
}
}
}
Retrieve Subdomain List - Deprecated ¶
GET/v6_0/rkszones/domains/{id}/subdomain
Use this API command to retrieve a list of subdomain by specified Domain ID.
Deprecated : this URI will be deprecated after Version: v6_0, not support.For the alternative URI, please refer to the “Retrieve Subdomain List” section of the category “Domain”.
- 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
- recursively
string
(optional)Get domain list recursively.
- includeSelf
string
(optional)Get domain list include Self.
- excludeRegularDomain
string
(optional)
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "domainUUID",
"name": "testDomain_1",
"domainType": "REGULAR",
"description": null,
"createdBy": "admin",
"createDatetime": "2017/05/03 10:15:01",
"parentDomainId": "parentDomainUUId",
"zoneCount": 0,
"subDomainCount": 0,
"administratorCount": 0,
"apCount": 0
}
]
}
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 domain",
"type": "string"
},
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"type": "string"
},
"description": {
"description": "Description of the domain",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createdBy": {
"description": "Created by",
"type": "string"
},
"createDatetime": {
"description": "Created by",
"type": "string"
},
"zoneCount": {
"description": "# of Zones",
"type": "Integer"
},
"subDomainCount": {
"description": "# of Subdomains",
"type": "integer"
},
"administratorCount": {
"description": "# of Subdomains",
"type": "integer"
},
"apCount": {
"description": "# of Subdomains",
"type": "integer"
},
"parentDomainId": {
"description": "Parent Domain Id",
"type": "string"
}
}
}
}
}
}
Retrieve Subdomain List ¶
GET/v6_1/domains/{id}/subdomain
Use this API command to retrieve a list of subdomain by specified Domain ID.
- 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
- recursively
string
(optional)Get domain list recursively.
- includeSelf
string
(optional)Get domain list include Self.
- excludeRegularDomain
string
(optional)
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "domainUUID",
"name": "testDomain_1",
"domainType": "REGULAR",
"description": null,
"createdBy": "admin",
"createDatetime": "2017/05/03 10:15:01",
"parentDomainId": "parentDomainUUId",
"zoneCount": 0,
"subDomainCount": 0,
"administratorCount": 0,
"apCount": 0
}
]
}
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 domain",
"type": "string"
},
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"type": "string"
},
"description": {
"description": "Description of the domain",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createdBy": {
"description": "Created by",
"type": "string"
},
"createDatetime": {
"description": "Created by",
"type": "string"
},
"zoneCount": {
"description": "# of Zones",
"type": "Integer"
},
"subDomainCount": {
"description": "# of Subdomains",
"type": "integer"
},
"administratorCount": {
"description": "# of Subdomains",
"type": "integer"
},
"apCount": {
"description": "# of Subdomains",
"type": "integer"
},
"parentDomainId": {
"description": "Parent Domain Id",
"type": "string"
}
}
}
}
}
}
Retrieve - Deprecated ¶
GET/v6_0/rkszones/domains/{id}
Use this API command to retrieve domain by specified Domain ID.
Deprecated : this URI will be deprecated after Version: v6_0, not support.For the alternative URI, please refer to the “Retrieve” section of the category “Domain”.
- recursively
string
(optional)
200
Body
{
"id": "domainUUID",
"name": "testDomain_1",
"domainType": "REGULAR",
"description": null,
"createdBy": "admin",
"createDatetime": "2017/05/03 10:15:01",
"parentDomainId": "parentDomainUUId",
"zoneCount": 0,
"subDomainCount": 0,
"administratorCount": 0,
"apCount": 0
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the domain",
"type": "string"
},
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"type": "string"
},
"description": {
"description": "Description of the domain",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createdBy": {
"description": "Created by",
"type": "string"
},
"createDatetime": {
"description": "Created by",
"type": "string"
},
"zoneCount": {
"description": "# of Zones",
"type": "Integer"
},
"subDomainCount": {
"description": "# of Subdomains",
"type": "integer"
},
"administratorCount": {
"description": "# of Subdomains",
"type": "integer"
},
"apCount": {
"description": "# of Subdomains",
"type": "integer"
},
"parentDomainId": {
"description": "Parent Domain Id",
"type": "string"
}
}
}
Retrieve ¶
GET/v6_1/domains/{id}
Use this API command to retrieve domain by specified Domain ID.
- recursively
string
(optional)
200
Body
{
"id": "domainUUID",
"name": "testDomain_1",
"domainType": "REGULAR",
"description": null,
"createdBy": "admin",
"createDatetime": "2017/05/03 10:15:01",
"parentDomainId": "parentDomainUUId",
"zoneCount": 0,
"subDomainCount": 0,
"administratorCount": 0,
"apCount": 0
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the domain",
"type": "string"
},
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"type": "string"
},
"description": {
"description": "Description of the domain",
"type": [
"string",
"null"
],
"maxLength": 64
},
"createdBy": {
"description": "Created by",
"type": "string"
},
"createDatetime": {
"description": "Created by",
"type": "string"
},
"zoneCount": {
"description": "# of Zones",
"type": "Integer"
},
"subDomainCount": {
"description": "# of Subdomains",
"type": "integer"
},
"administratorCount": {
"description": "# of Subdomains",
"type": "integer"
},
"apCount": {
"description": "# of Subdomains",
"type": "integer"
},
"parentDomainId": {
"description": "Parent Domain Id",
"type": "string"
}
}
}
Create - Deprecated ¶
POST/v6_0/rkszones/domains
Use this API command to create new domain.
Deprecated : this URI will be deprecated after Version: v6_0, not support.For the alternative URI, please refer to the “Create” section of the category “Domain”.
- parentDomainId
string
(optional)
Body
{
"name": "testDomain_1"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"enum": [
"PARTNER",
"MVNO",
"REGULAR"
]
},
"parentDomainId": {
"description": "parent domain id",
"type": "string"
},
"description": {
"description": "Description of the domain name",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"name"
]
}
201
Body
{
"id": "domainUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Create ¶
POST/v6_1/domains
Use this API command to create new domain.
- parentDomainId
string
(optional)
Body
{
"name": "testDomain_1"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"enum": [
"PARTNER",
"MVNO",
"REGULAR"
]
},
"parentDomainId": {
"description": "parent domain id",
"type": "string"
},
"description": {
"description": "Description of the domain name",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"name"
]
}
201
Body
{
"id": "domainUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify - Deprecated ¶
PATCH/v6_0/rkszones/domains/{id}
Use this API command to modify the basic information of domain.
Deprecated : this URI will be deprecated after Version: v6_0, not support.For the alternative URI, please refer to the “Modify” section of the category “Domain”.
Body
{
"description": "testDomain"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"type": "string"
},
"parentDomainId": {
"description": "parent domain id",
"type": "string"
},
"description": {
"description": "Description of the domain",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
204
Modify ¶
PATCH/v6_1/domains/{id}
Use this API command to modify the basic information of domain.
Body
{
"description": "testDomain"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "domain name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"domainType": {
"description": "domain type",
"type": "string"
},
"parentDomainId": {
"description": "parent domain id",
"type": "string"
},
"description": {
"description": "Description of the domain",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}
204
Syslog Server ¶
Retrieve Syslog ¶
GET/v6_1/system/syslog
Retrieve syslog server sertting.
- 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
200
Body
{
"enabled": true,
"appLogFacility": "Local1",
"appLogSeverity": "Debug",
"auditLogFacility": "Local2",
"auditLogSeverity": "Debug",
"eventLogFacility": "Local2",
"otherLogSeverity": "Debug",
"forwardUEEventsMsgFormatType": "COMMON",
"eventFilter": 2,
"eventFilterSeverity": "Debug",
"primaryServer": {
"host": "192.1.0.1",
"port": 90,
"protocol": "UDP"
},
"secondaryServer": {
"host": "192.10.8.9",
"port": 82,
"protocol": "UDP",
"redundancyMode": "primary_backup"
},
"priority": {
"critical": "ERROR",
"major": "ERROR",
"minor": "WARN",
"warning": "WARN",
"informational": "INFO",
"debug": "DEBUG"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "enable logging to remote syslog server",
"type": "boolean"
},
"appLogFacility": {
"description": "appLogFacility: Local0-Local7",
"type": "string"
},
"auditLogFacility": {
"description": "auditLogFacility: Local0-Local7",
"type": "string"
},
"eventLogFacility": {
"description": "auditLogFacility: Local0-Local7",
"type": "string"
},
"appLogSeverity": {
"description": "appLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
"type": "string"
},
"auditLogSeverity": {
"description": "auditLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
"type": "string"
},
"otherLogSeverity": {
"description": "otherLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
"type": "string"
},
"forwardUEEventsMsgFormatType": {
"description": "forwardUEEventsMsgFormatType : COMMON, ZD",
"type": "string"
},
"primaryServer": {
"description": "The primary server settings of syslog server",
"type": "object",
"additionalProperties": false,
"properties": {
"host": {
"description": "address of the syslog server.",
"type": "string"
},
"port": {
"description": "port number of the syslog server",
"type": "integer"
},
"protocol": {
"description": "protocol of the syslog server",
"enum": [
"UDP",
"TCP"
]
}
}
},
"secondaryServer": {
"description": "The secondary server settings of syslog server",
"type": "object",
"additionalProperties": false,
"properties": {
"host": {
"description": "address of the syslog server.",
"type": "string"
},
"port": {
"description": "port number of the syslog server",
"type": "integer"
},
"protocol": {
"description": "protocol of the syslog server",
"enum": [
"UDP",
"TCP"
]
},
"redundancyMode": {
"description": "The redundancy mode of syslog server",
"enum": [
"active_active",
"primary_backup"
]
}
}
},
"eventFilter": {
"description": "Event Filter, 0 : All events, 1 : All events except client association/disassociation events, 2 : All events above a severity",
"type": "integer",
"minimum": 0,
"maximum": 2
},
"eventFilterSeverity": {
"description": "Event Filter Severity, This only applies when the Event Filter is set to 2",
"enum": [
"Critical",
"Major",
"Minor",
"Warning",
"Informational",
"Debug"
]
},
"priority": {
"description": "Priority",
"type": "object",
"additionalProperties": false,
"properties": {
"critical": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"major": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"minor": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"warning": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"informational": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"debug": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
}
}
}
}
}
Modify Syslog ¶
PATCH/v6_1/system/syslog
Modify syslog server setting.
Body
{
"enabled": true,
"appLogFacility": "Local1",
"appLogSeverity": "Debug",
"auditLogFacility": "Local2",
"auditLogSeverity": "Debug",
"eventLogFacility": "Local2",
"otherLogSeverity": "Debug",
"forwardUEEventsMsgFormatType": "COMMON",
"eventFilter": 2,
"eventFilterSeverity": "Debug",
"primaryServer": {
"host": "192.1.0.1",
"port": 90,
"protocol": "UDP"
},
"secondaryServer": {
"host": "192.10.8.9",
"port": 82,
"protocol": "UDP",
"redundancyMode": "primary_backup"
},
"priority": {
"critical": "ERROR",
"major": "ERROR",
"minor": "WARN",
"warning": "WARN",
"informational": "INFO",
"debug": "DEBUG"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "enable logging to remote syslog server",
"type": "boolean"
},
"appLogFacility": {
"description": "appLogFacility: Local0-Local7",
"type": "string"
},
"auditLogFacility": {
"description": "auditLogFacility: Local0-Local7",
"type": "string"
},
"eventLogFacility": {
"description": "Facility for Event",
"type": "string"
},
"appLogSeverity": {
"description": "appLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
"type": "string"
},
"auditLogSeverity": {
"description": "auditLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
"type": "string"
},
"otherLogSeverity": {
"description": "otherLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
"type": "string"
},
"forwardUEEventsMsgFormatType": {
"description": "forwardUEEventsMsgFormatType : COMMON, ZD",
"type": "string"
},
"primaryServer": {
"description": "The primary server settings of syslog server",
"type": "object",
"additionalProperties": false,
"properties": {
"host": {
"description": "address of the syslog server.",
"type": "string"
},
"port": {
"description": "port number of the syslog server",
"type": "integer"
},
"protocol": {
"description": "protocol of the syslog server",
"enum": [
"UDP",
"TCP"
]
}
}
},
"secondaryServer": {
"description": "The secondary server settings of syslog server",
"type": "object",
"additionalProperties": false,
"properties": {
"host": {
"description": "address of the syslog server.",
"type": "string"
},
"port": {
"description": "port number of the syslog server",
"type": "integer"
},
"protocol": {
"description": "protocol of the syslog server",
"enum": [
"UDP",
"TCP"
]
},
"redundancyMode": {
"description": "The redundancy mode of syslog server",
"enum": [
"active_active",
"primary_backup"
]
}
}
},
"eventFilter": {
"description": "Event Filter, 0 : All events, 1 : All events except client association/disassociation events, 2 : All events above a severity",
"type": "integer",
"minimum": 0,
"maximum": 2
},
"eventFilterSeverity": {
"description": "Event Filter Severity, This only applies when the Event Filter is set to 2",
"enum": [
"Critical",
"Major",
"Minor",
"Warning",
"Informational",
"Debug"
],
"default": "Debug"
},
"priority": {
"description": "Priority",
"type": "object",
"additionalProperties": false,
"properties": {
"critical": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"major": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"minor": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"warning": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"informational": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"debug": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
}
}
}
}
}
204
Modify Primary Server ¶
PATCH/v6_1/system/syslog/primaryServer
Modify Primary Server of syslog.
Body
{
"host": "192.1.0.1",
"port": 90,
"protocol": "UDP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"host": {
"description": "address of the syslog server.",
"type": "string"
},
"port": {
"description": "port number of the syslog server",
"type": "integer"
},
"protocol": {
"description": "protocol of the syslog server",
"enum": [
"UDP",
"TCP"
]
}
}
}
204
Modify Secondary Server ¶
PATCH/v6_1/system/syslog/secondaryServer
Modify Secondary Server of syslog.
Body
{
"host": "192.10.8.9",
"port": 82,
"protocol": "UDP",
"redundancyMode": "primary_backup"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"host": {
"description": "address of the syslog server.",
"type": "string"
},
"port": {
"description": "port number of the syslog server",
"type": "integer"
},
"protocol": {
"description": "protocol of the syslog server",
"enum": [
"UDP",
"TCP"
]
},
"redundancyMode": {
"description": "The redundancy mode of syslog server",
"enum": [
"active_active",
"primary_backup"
]
}
}
}
204
Modify Priority ¶
PATCH/v6_1/system/syslog/priority
Modify Priority of syslog.
Body
{
"critical": "ERROR",
"major": "ERROR",
"minor": "WARN",
"warning": "WARN",
"informational": "INFO",
"debug": "DEBUG"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"critical": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"major": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"minor": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"warning": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"informational": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
},
"debug": {
"description": "Event severity",
"enum": [
"ERROR",
"WARN",
"INFO",
"DEBUG"
]
}
}
}
204
Control Planes ¶
Retrieve List ¶
GET/v6_1/controlPlanes
Use this API command to retrieve the list of control plane.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "cc2ae3a2-8221-4bd3-a5c2-bfed116f07c6",
"name": "Control plane name",
"managementIp": "172.17.60.150",
"clusterIp": "10.2.3.165",
"controlIp": "10.2.3.164",
"model": "SCG200",
"serialNumber": "00000089",
"numOfAps": 0,
"description": "Automatic installed J-SCG200-35-824",
"clusterRole": "Leader",
"uptime": "20.0h 14.0m"
}
]
}
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 control plane",
"type": "string"
},
"name": {
"description": "Name of the control plane",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"managementIp": {
"description": "Management IP",
"type": "string"
},
"clusterIp": {
"description": "Cluster IP",
"type": "string"
},
"controlIp": {
"description": "Control IP",
"type": "string"
},
"model": {
"description": "Model",
"type": "string"
},
"serialNumber": {
"description": "Serial Number",
"type": "string"
},
"numOfAps": {
"description": "Total Connected APs",
"type": "string"
},
"description": {
"description": "Description",
"type": "string"
},
"firmware": {
"description": "Firmware",
"type": "string"
},
"clusterRole": {
"description": "Cluster Role",
"type": "string"
},
"upTime": {
"description": "Uptime",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/controlPlanes/{bladeUUID}
Use this API command to retrieve control plane.
200
Body
{
"enableAccessAndCoreSeparation": false,
"ipv4ControlInterface": {
"ipMode": "STATIC",
"ipAddress": "10.2.3.164",
"subnetMask": "255.255.0.0"
},
"ipv4ClusterInterface": {
"ipMode": "STATIC",
"ipAddress": "10.2.3.165",
"subnetMask": "255.255.0.0"
},
"ipv4ManagementInterface": {
"ipMode": "STATIC",
"ipAddress": "172.17.60.150",
"subnetMask": "255.255.254.0",
"gateway": "172.17.60.1"
},
"ipv4AccessAndCoreSeparation": {
"defaultGateway": "Management",
"primaryDNSServer": "8.8.8.8",
"secondaryDNSServer": "8.8.4.4"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ipv4ControlInterface": {
"description": "IPv4 Control Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"natIp": {
"description": "NAT IP",
"type": "string"
}
}
},
"ipv4ClusterInterface": {
"description": "IPv4 Cluster Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
},
"ipv4ManagementInterface": {
"description": "IPv4 Management Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
},
"ipv6ControlInterface": {
"description": "IPv6 Control Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
},
"ipv6ManagementInterface": {
"description": "IPv6 Control Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
},
"ipv4AccessAndCoreSeparation": {
"description": "IPv6 Control Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"defaultGateway": {
"description": "Gateway",
"enum": [
"Control",
"Management",
"Cluster"
]
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
},
"ipv6AccessAndCoreSeparation": {
"description": "IPv6 Control Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"defaultGateway": {
"description": "Gateway",
"enum": [
"Control",
"Management",
"Cluster"
]
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
},
"ipMode": {
"description": "IP support version",
"enum": [
"IPV4",
"IPV4_IPV6"
]
}
}
}
Modify ¶
PATCH/v6_1/controlPlanes/{bladeUUID}
Use this API command to modify the basic information of control plane.
Body
{
"enableAccessAndCoreSeparation": false,
"ipv4ControlInterface": {
"ipMode": "STATIC",
"ipAddress": "10.2.3.164",
"subnetMask": "255.255.0.0"
},
"ipv4ClusterInterface": {
"ipMode": "STATIC",
"ipAddress": "10.2.3.165",
"subnetMask": "255.255.0.0"
},
"ipv4ManagementInterface": {
"ipMode": "STATIC",
"ipAddress": "172.17.60.150",
"subnetMask": "255.255.254.0",
"gateway": "172.17.60.1"
},
"ipv6ControlInterface": {
"ipMode": "STATIC",
"ipAddress": "2222:3333::5555/64"
},
"ipv6ManagementInterface": {
"ipMode": "STATIC",
"ipAddress": "2222:3333::5555/64"
},
"ipv4AccessAndCoreSeparation": {
"defaultGateway": "Management",
"primaryDNSServer": "8.8.8.8",
"secondaryDNSServer": "8.8.4.4"
},
"ipv6AccessAndCoreSeparation": {
"defaultGateway": "Management",
"primaryDNSServer": "2222:3333::5555"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ipv4ControlInterface": {
"description": "IPv4 Control Interface for control plane",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"natIp": {
"description": "NAT IP",
"type": "string"
}
}
},
"ipv4ClusterInterface": {
"description": "IPv4 Cluster Interface for control plane",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
},
"ipv4ManagementInterface": {
"description": "IPv4 Management Interface for control plane",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
},
"ipv6ControlInterface": {
"description": "IPv6 Control Interface for IP mode is IPv4 and IPv6",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
},
"ipv6ManagementInterface": {
"description": "IPv6 Control Interface for for IP mode is IPv4 and IPv6",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
},
"enableAccessAndCoreSeparation": {
"description": "Enable Access & Core Separation",
"type": "boolean"
},
"ipv4AccessAndCoreSeparation": {
"description": "IPv6 Control Interface for control plane",
"type": "object",
"additionalProperties": false,
"properties": {
"defaultGateway": {
"description": "Gateway",
"enum": [
"Control",
"Management",
"Cluster"
]
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
},
"ipv6AccessAndCoreSeparation": {
"description": "IPv6 Control Interface for for IP mode is IPv4 and IPv6",
"type": "object",
"additionalProperties": false,
"properties": {
"defaultGateway": {
"description": "Gateway",
"enum": [
"Control",
"Management",
"Cluster"
]
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
}
}
}
204
Modify IPV4 Control Interface ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/ipv4ControlInterface
Use this API command to modify IPv4 control information of control plane.
Body
{
"ipMode": "STATIC",
"ipAddress": "10.2.3.164",
"subnetMask": "255.255.0.0"
}
Schema
{
"description": "IPv4 Control Interface for control plane",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"natIp": {
"description": "NAT IP",
"type": "string"
}
}
}
204
Modify IPV4 Cluster Interface ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/ipv4ClusterInterface
Use this API command to modify IPv4 cluster information of control plane.
Body
{
"ipMode": "STATIC",
"ipAddress": "10.2.3.165",
"subnetMask": "255.255.0.0"
}
Schema
{
"description": "IPv4 Cluster Interface for control plane",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
}
204
Modify IPV4 Management Interface ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/ipv4ManagementInterface
Use this API command to modify IPv4 management information of control plane.
Body
{
"ipMode": "STATIC",
"ipAddress": "172.17.60.150",
"subnetMask": "255.255.254.0",
"gateway": "172.17.60.1"
}
Schema
{
"description": "IPv4 Management Interface for control plane",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
}
204
Modify IPv6 Control Interface ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/ipv6ControlInterface
Use this API command to modify IPv6 control information of control plane.
Body
{
"ipMode": "STATIC",
"ipAddress": "2222:3333::5555/64"
}
Schema
{
"description": "IPv6 Control Interface for IP mode is IPv4 and IPv6",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
}
204
Modify IPv6 Management Interface ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/ipv6ManagementInterface
Use this API command to modify IPv6 management information of control plane.
Body
{
"ipMode": "STATIC",
"ipAddress": "2222:3333::5555/64"
}
Schema
{
"description": "IPv6 Control Interface for for IP mode is IPv4 and IPv6",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
}
}
204
Modify IPv4 Access And Core Separation ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/ipv4AccessAndCoreSeparation
Use this API command to modify IPv4 access and core information of control plane.
Body
{
"defaultGateway": "Management",
"primaryDNSServer": "8.8.8.8",
"secondaryDNSServer": "8.8.4.4"
}
Schema
{
"description": "IPv6 Control Interface for control plane",
"type": "object",
"additionalProperties": false,
"properties": {
"defaultGateway": {
"description": "Gateway",
"enum": [
"Control",
"Management",
"Cluster"
]
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
}
204
Modify IPv6 Access And Core Separation ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/ipv6AccessAndCoreSeparation
Use this API command to modify IPv6 access and core information of control plane.
Body
{
"defaultGateway": "Management",
"primaryDNSServer": "2222:3333::5555"
}
Schema
{
"description": "IPv6 Control Interface for for IP mode is IPv4 and IPv6",
"type": "object",
"additionalProperties": false,
"properties": {
"defaultGateway": {
"description": "Gateway",
"enum": [
"Control",
"Management",
"Cluster"
]
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
}
204
Retrieve static route ¶
GET/v6_1/controlPlanes/{bladeUUID}/staticRoutes
Use this API command to retrieve static route of control plane.
200
Body
{
"staticRoutes": [
{
"networkAddress": "10.4.0.0",
"subnetMask": "255.255.0.0",
"gateway": "10.2.0.1",
"interfaceMode": "Control",
"metric": 4
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"staticRoutes": {
"type": "array",
"description": "Static route for Control Plane",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "Network Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"interfaceMode": {
"description": "Interface Mode",
"type": "string"
},
"metric": {
"description": "Metric",
"type": "integer",
"minimum": 0,
"maximum": 999
}
}
}
}
}
}
Modify Static Route ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/staticRoutes
Use this API command to modify the static route of control plane.
Body
[
{
"networkAddress": "10.4.0.0",
"subnetMask": "255.255.0.0",
"gateway": "10.2.0.1",
"interfaceMode": "Control",
"metric": 4
}
]
Schema
{
"type": "array",
"description": "Static route for control plane.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "Network Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"interfaceMode": {
"description": "Interface Mode",
"type": "string"
},
"metric": {
"description": "Metric",
"type": "integer",
"minimum": 0,
"maximum": 999
}
}
}
}
204
Delete Static Route ¶
DELETE/v6_1/controlPlanes/{bladeUUID}/staticRoutes
Use this API command to delete the static route of control plane.
204
Retrieve user defined interface ¶
GET/v6_1/controlPlanes/{bladeUUID}/userDefinedInterface
Use this API command to retrieve user defined interface of control plane.
200
Body
{
"userDefinedInterface": [
{
"name": "User Defined Interface name",
"physicalInterface": "Control",
"service": "NotSpecified",
"ipAddress": "1.1.1.1",
"subnetMask": "255.255.255.0",
"vlan": "5"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"userDefinedInterface": {
"type": "array",
"description": "User defined interface for Control Plane",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name",
"type": "string"
},
"physicalInterface": {
"description": "Physical interface",
"enum": [
"Control",
"Management",
"Cluster"
]
},
"service": {
"description": "Service",
"enum": [
"NotSpecified",
"Hotspot"
]
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"vlan": {
"description": "Vlan",
"type": "string"
}
}
}
}
}
}
Modify User Defined Interface ¶
PATCH/v6_1/controlPlanes/{bladeUUID}/userDefinedInterface
Use this API command to modify user defined interface of control plane.
Body
[
{
"name": "User Defined Interface name",
"physicalInterface": "Control",
"service": "NotSpecified",
"ipAddress": "1.1.1.1",
"subnetMask": "255.255.255.0",
"vlan": "5"
}
]
Schema
{
"type": "array",
"description": "User defined interface for Control Plane",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name",
"type": "string"
},
"physicalInterface": {
"description": "Physical interface",
"enum": [
"Control",
"Management",
"Cluster"
]
},
"service": {
"description": "Service",
"enum": [
"NotSpecified",
"Hotspot"
]
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"vlan": {
"description": "Vlan",
"type": "string"
}
}
}
}
204
Delete User Defined Interface ¶
DELETE/v6_1/controlPlanes/{bladeUUID}/userDefinedInterface
Use this API command to delete the user defined interface of control plane.
204
Modify IP support ¶
PATCH/v6_1/controlPlanes/ipSupport
Use this API command to modify ip support of control plane.
Body
{
"ipMode": "IPV4_IPV6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP support version",
"enum": [
"IPV4",
"IPV4_IPV6"
]
}
},
"required": [
"ipMode"
]
}
204
ZDImport ¶
Connect to ZD ¶
POST/v6_1/zdImport/connectZD
Connect to ZD.
Body
{
"user": "admin",
"password": "admin!234",
"ip": "172.17.60.24",
"apMacList": [
"E0:11:12:23:F2:22"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"user": {
"description": "ZD user name",
"type": "string"
},
"password": {
"description": "ZD password",
"type": "string"
},
"ip": {
"description": "ZD IP address",
"type": "string"
},
"apMacList": {
"description": "List of AP MAC",
"type": "array",
"items": {
"type": "string"
}
}
}
}
201
Body
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Get ZD AP ¶
GET/v6_1/zdImport/getZDAPs
Get ZD AP.
- ip
string
(required)
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"mac": "E0:11:12:23:F2:22",
"connected": "false"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "AP MAC",
"type": "string"
},
"connected": {
"description": "AP Conntected",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
ZD Migrate ¶
POST/v6_1/zdImport/migrate
Migrate ZD to SCG.
Body
{
"user": "admin",
"password": "admin!234",
"ip": "172.17.60.24",
"apMacList": [
"E0:11:12:23:F2:22"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"user": {
"description": "ZD user name",
"type": "string"
},
"password": {
"description": "ZD password",
"type": "string"
},
"ip": {
"description": "ZD IP address",
"type": "string"
},
"apMacList": {
"description": "List of AP MAC",
"type": "array",
"items": {
"type": "string"
}
}
}
}
201
Body
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Get Migrate Status ¶
GET/v6_1/zdImport/status
Get Migrate Status.
- details
string
(optional)
200
Body
{
"message": "migarating",
"details": "details",
"state": "migarating",
"progress": 50
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"message": {
"description": "Message",
"type": "string"
},
"details": {
"description": "Details",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"progress": {
"description": "Progress",
"type": "integer"
}
}
}
Administration ¶
Get all licenses ¶
GET/v6_1/licenses
Use this API command to get all licenses currently assign in SCG.
200
Body
{
"totalCount": 4,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"description": "Default AP Capacity License for SZ300",
"name": "CAPACITY-AP-DEFAULT",
"count": 10000,
"createTime": "2017/08/16",
"expireDate": "2017/11/13"
},
{
"description": "Default feature license for URL Filtering",
"name": "FEATURE-URL-FILTERING-DEFAULT",
"count": 10000,
"createTime": "2017/08/16",
"expireDate": "2017/11/13"
},
{
"description": "Default AP Direct Tunnel License for SZ300",
"name": "CAPACITY-RXGW-DEFAULT",
"count": 10000,
"createTime": "2017/08/16",
"expireDate": "2017/11/13"
},
{
"description": "Default SZ 300 Support License",
"name": "SUP-SZ300-EU-DEFAULT",
"count": 1,
"createTime": "2017/08/16",
"expireDate": "2017/11/13"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "license description",
"type": "string"
},
"name": {
"description": "license name",
"type": "string"
},
"count": {
"description": "number of licenses",
"type": "integer"
},
"createTime": {
"description": "license effective date",
"type": "string"
},
"expireDate": {
"description": "license expiry date",
"type": "string"
}
}
}
}
}
}
Get licenses summary information ¶
GET/v6_1/licensesSummary
Use this API command to get licenses summary information.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"licenseTypeDescription": "AP Capacity License",
"capacityControlLicenseCount": {
"totalCount": 1000,
"usedCount": 0
}
},
{
"licenseTypeDescription": "AP Direct Tunnel License",
"capacityControlLicenseCount": {
"totalCount": 1000,
"usedCount": 0
}
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"licenseTypeDescription": {
"description": "license type description",
"type": "string"
},
"capacityControlLicenseCount": {
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "total count of licenses",
"type": "integer"
},
"usedCount": {
"description": "consumed count of licenses",
"type": "integer"
}
}
}
}
}
}
}
}
Sync licenses ¶
PUT/v6_1/licenses/sync
Use this API command to ask all SCG in cluster to sync licenses from license server.
204
Get licenses synchronize logs ¶
GET/v6_1/licensesSyncLogs
Use this API command to get licenses synchronize logs.
200
Body
{
"totalCount": 4,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"syncResult": "SUCCESS",
"createDateTime": "2017/08/25 02:33:10"
},
{
"syncResult": "SUCCESS",
"createDateTime": "2017/08/25 02:32:23"
},
{
"syncResult": "SUCCESS",
"createDateTime": "2017/08/25 00:43:40"
},
{
"syncResult": "SUCCESS",
"createDateTime": "2017/08/24 05:44:27"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"syncResult": {
"description": "sync license result",
"enum": [
"SUCCESS",
"FAILURE"
]
},
"createDateTime": {
"description": "license sync log's create time",
"type": "string"
}
}
}
}
}
}
Get license server ¶
GET/v6_1/licenseServer
Use this API command to get license server configuration.
200
Body
{
"useCloud": false,
"ipAddress": "192.168.0.1",
"port": 3223
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"useCloud": {
"description": "use cloud license server",
"type": "boolean"
},
"ipAddress": {
"description": "local license server IP address",
"type": "string"
},
"port": {
"description": "local license server port",
"type": "integer",
"minimum": 0,
"maximum": 65535
}
}
}
Update license server ¶
PUT/v6_1/licenseServer
Use this API command to update license server configuration.
Body
{
"useCloud": false,
"ipAddress": "192.168.0.1",
"port": 3223
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"useCloud": {
"description": "use cloud license server",
"type": "boolean"
},
"ipAddress": {
"description": "local license server IP address",
"type": "string"
},
"port": {
"description": "local license server port",
"type": "integer",
"minimum": 0,
"maximum": 65535
}
}
}
204
Upload Statistics to FTP ¶
Retrieve ¶
GET/v6_1/globalSettings/statsFtp
Use this API command to retrieve the uploading statistical data to FTP server setting.
200
Body
{
"enabled": true,
"ftpInterval": "Hourly",
"ftpId": "ftpId"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "enable logging to remote syslog server",
"type": "boolean"
},
"ftpInterval": {
"description": "ftpInterval",
"enum": [
"Hourly"
]
},
"ftpId": {
"description": "Identifier of the FTP Server",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/globalSettings/statsFtp
Use this API command to modify the setting of uploading statistical data to FTP server.
Body
{
"enabled": true,
"ftpInterval": "Hourly",
"ftpId": "ftpId"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "enable logging to remote syslog server",
"type": "boolean"
},
"ftpInterval": {
"description": "ftpInterval",
"enum": [
"Hourly"
]
},
"ftpId": {
"description": "Identifier of the FTP Server",
"type": "string"
}
}
}
204
Global reference ¶
Get friendly name of usable language ¶
GET/v6_1/globalSettings/friendlyNameLang
Use this API command to get friendly name of usable language for profile: Hotspot2.0 Identity Provider.
200
Body
{
"rawDataTotalCount": 0,
"totalCount": 12,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"display": "French",
"value": "fre"
},
{
"display": "Swedish",
"value": "swe"
},
{
"display": "English",
"value": "eng"
},
{
"display": "Danish",
"value": "dan"
},
{
"display": "Japanese",
"value": "jpn"
},
{
"display": "German",
"value": "ger"
},
{
"display": "Turkish",
"value": "tur"
},
{
"display": "Korean",
"value": "kor"
},
{
"display": "Czech",
"value": "cze"
},
{
"display": "Chinese",
"value": "chi"
},
{
"display": "Spanish",
"value": "spa"
},
{
"display": "Dutch",
"value": "dut"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total count of FriendlyName of language",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more FriendlyName of language after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first FriendlyName of language returned out of the complete FTP list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"display": {
"description": "Display name",
"type": "string"
},
"value": {
"description": "value of language used on create Hotspot 2.0 Identity provider (Language in OSU Service Description) profile",
"type": "string"
}
}
}
}
}
}
Get friendly name of usable language ¶
GET/v6_1/globalSettings/portalLang
Use this API command to get friendly name of usable language for profile: Guest Access (Language in General Options), Web Auth (Language in General Options).
200
Body
{
"rawDataTotalCount": 0,
"totalCount": 14,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"display": "Turkish",
"value": "tr_TR"
},
{
"display": "Brazilian Portuguese",
"value": "pt_BR"
},
{
"display": "French",
"value": "fr_FR"
},
{
"display": "Chinese Simplified",
"value": "zh_CN"
},
{
"display": "Spanish",
"value": "es_ES"
},
{
"display": "Swedish",
"value": "se_SE"
},
{
"display": "Dutch",
"value": "nl_NL"
},
{
"display": "Danish",
"value": "da_DK"
},
{
"display": "Arabic",
"value": "ar_SA"
},
{
"display": "Chinese Traditional",
"value": "zh_TW"
},
{
"display": "Japanese",
"value": "ja_JP"
},
{
"display": "German",
"value": "de_DE"
},
{
"display": "Czech",
"value": "cz_CZ"
},
{
"display": "English",
"value": "en_US"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total portal name count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more portal names after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first portal names returned out of the complete portal names list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"display": {
"description": "Display name",
"type": "string"
},
"value": {
"description": "value of language used on create Hotspot 2.0 Identity provider (Language in OSU Service Description) profile",
"type": "string"
}
}
}
}
}
}
FtpServerSettings ¶
Add FTP server ¶
POST/v6_1/ftps
Add FTP server.
Body
{
"id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
"domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
"ftpHost": "172.30.1.1",
"ftpPort": 22,
"ftpRemoteDirectory": "/home/user",
"ftpUserName": "user",
"ftpPassword": "passowrd",
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"createDatetime": 1452527522341,
"lastModifiedBy": "admin",
"lastModifiedOn": 1462527522341,
"ftpName": "Ftp Server",
"ftpProtocol": "FTP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "FTP Id",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"ftpHost": {
"description": "IP/DN of FTP",
"type": "string"
},
"ftpPort": {
"description": "Port used by FTP",
"type": "integer",
"minimum": 21,
"maximum": 65535
},
"ftpRemoteDirectory": {
"description": "Destination directory used for file upload",
"type": "string"
},
"ftpUserName": {
"description": "Username for login",
"type": "string"
},
"ftpPassword": {
"description": "Password for login",
"type": "string"
},
"creatorUUID": {
"description": "creator id",
"type": "string"
},
"createDatetime": {
"description": "entry create time",
"type": "integer"
},
"lastModifiedBy": {
"description": "last modified user",
"type": "string"
},
"lastModifiedOn": {
"description": "last modified time",
"type": "integer"
},
"ftpName": {
"description": "FTP name",
"type": "string"
},
"ftpProtocol": {
"description": "Protocol used",
"enum": [
"FTP",
"SFTP"
]
}
}
}
201
Update FTP server ¶
PATCH/v6_1/ftps/{ftpId}
Update FTP server settings.
Body
{
"id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
"domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
"ftpHost": "172.30.1.1",
"ftpPort": 22,
"ftpRemoteDirectory": "/home/user",
"ftpUserName": "user",
"ftpPassword": "passowrd",
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"createDatetime": 1452527522341,
"lastModifiedBy": "admin",
"lastModifiedOn": 1462527522341,
"ftpName": "Ftp Server",
"ftpProtocol": "FTP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "FTP Id",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"ftpHost": {
"description": "IP/DN of FTP",
"type": "string"
},
"ftpPort": {
"description": "Port used by FTP",
"type": "integer",
"minimum": 21,
"maximum": 65535
},
"ftpRemoteDirectory": {
"description": "Destination directory used for file upload",
"type": "string"
},
"ftpUserName": {
"description": "Username for login",
"type": "string"
},
"ftpPassword": {
"description": "Password for login",
"type": "string"
},
"creatorUUID": {
"description": "creator id",
"type": "string"
},
"createDatetime": {
"description": "entry create time",
"type": "integer"
},
"lastModifiedBy": {
"description": "last modified user",
"type": "string"
},
"lastModifiedOn": {
"description": "last modified time",
"type": "integer"
},
"ftpName": {
"description": "FTP name",
"type": "string"
},
"ftpProtocol": {
"description": "Protocol used",
"enum": [
"FTP",
"SFTP"
]
}
}
}
204
Remove FTP servers ¶
DELETE/v6_1/ftps
Remove FTP servers.
Body
{
"idList": [
"71d7b8a9-33ed-45e4-9140-7b2c31e5d6f5",
"7c450388-8b67-4b01-b926-d71ec48b4d20"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
200
Retrieve FTP server list ¶
POST/v6_1/ftps/query
Retrieve information of all FTP server. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 20,
"hasMore": true,
"firstIndex": 0,
"extra": "",
"list": [
{
"id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
"domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
"ftpHost": "172.30.1.1",
"ftpPort": 22,
"ftpRemoteDirectory": "/home/user",
"ftpUserName": "user",
"ftpPassword": "passowrd",
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"createDatetime": 1452527522341,
"lastModifiedBy": "admin",
"lastModifiedOn": 1462527522341,
"ftpName": "Ftp Server",
"ftpProtocol": "FTP"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total FTP count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more FTPs after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first FTP returned out of the complete FTP list",
"type": "integer"
},
"extra": {
"description": "extra information for ftp",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "FTP Id",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"ftpHost": {
"description": "IP/DN of FTP",
"type": "string"
},
"ftpPort": {
"description": "Port used by FTP",
"type": "integer",
"minimum": 21,
"maximum": 65535
},
"ftpRemoteDirectory": {
"description": "Destination directory used for file upload",
"type": "string"
},
"ftpUserName": {
"description": "Username for login",
"type": "string"
},
"ftpPassword": {
"description": "Password for login",
"type": "string"
},
"creatorUUID": {
"description": "creator id",
"type": "string"
},
"createDatetime": {
"description": "entry create time",
"type": "integer"
},
"lastModifiedBy": {
"description": "last modified user",
"type": "string"
},
"lastModifiedOn": {
"description": "last modified time",
"type": "integer"
},
"ftpName": {
"description": "FTP name",
"type": "string"
},
"ftpProtocol": {
"description": "Protocol used",
"enum": [
"FTP",
"SFTP"
]
}
}
}
}
}
}
Retrieve FTP server information ¶
GET/v6_1/ftps/{ftpId}
Retrieve information of specific FTP server.
200
Body
{
"id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
"domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
"ftpHost": "172.30.1.1",
"ftpPort": 22,
"ftpRemoteDirectory": "/home/user",
"ftpUserName": "user",
"ftpPassword": "passowrd",
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"createDatetime": 1452527522341,
"lastModifiedBy": "admin",
"lastModifiedOn": 1462527522341,
"ftpName": "Ftp Server",
"ftpProtocol": "FTP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "FTP Id",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"ftpHost": {
"description": "IP/DN of FTP",
"type": "string"
},
"ftpPort": {
"description": "Port used by FTP",
"type": "integer",
"minimum": 21,
"maximum": 65535
},
"ftpRemoteDirectory": {
"description": "Destination directory used for file upload",
"type": "string"
},
"ftpUserName": {
"description": "Username for login",
"type": "string"
},
"ftpPassword": {
"description": "Password for login",
"type": "string"
},
"creatorUUID": {
"description": "creator id",
"type": "string"
},
"createDatetime": {
"description": "entry create time",
"type": "integer"
},
"lastModifiedBy": {
"description": "last modified user",
"type": "string"
},
"lastModifiedOn": {
"description": "last modified time",
"type": "integer"
},
"ftpName": {
"description": "FTP name",
"type": "string"
},
"ftpProtocol": {
"description": "Protocol used",
"enum": [
"FTP",
"SFTP"
]
}
}
}
Test FTP server ¶
GET/v6_1/ftps/test
Test ftp server of specific FTP server settings.
Body
{
"id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
"domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
"ftpHost": "172.30.1.1",
"ftpPort": 22,
"ftpRemoteDirectory": "/home/user",
"ftpUserName": "user",
"ftpPassword": "passowrd",
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"createDatetime": 1452527522341,
"lastModifiedBy": "admin",
"lastModifiedOn": 1462527522341,
"ftpName": "Ftp Server",
"ftpProtocol": "FTP"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "FTP Id",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"ftpHost": {
"description": "IP/DN of FTP",
"type": "string"
},
"ftpPort": {
"description": "Port used by FTP",
"type": "integer",
"minimum": 21,
"maximum": 65535
},
"ftpRemoteDirectory": {
"description": "Destination directory used for file upload",
"type": "string"
},
"ftpUserName": {
"description": "Username for login",
"type": "string"
},
"ftpPassword": {
"description": "Password for login",
"type": "string"
},
"creatorUUID": {
"description": "creator id",
"type": "string"
},
"createDatetime": {
"description": "entry create time",
"type": "integer"
},
"lastModifiedBy": {
"description": "last modified user",
"type": "string"
},
"lastModifiedOn": {
"description": "last modified time",
"type": "integer"
},
"ftpName": {
"description": "FTP name",
"type": "string"
},
"ftpProtocol": {
"description": "Protocol used",
"enum": [
"FTP",
"SFTP"
]
}
}
}
200
Body
{
"success": "true",
"error": "",
"data": "true",
"extra": ""
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "The status of http request",
"type": "boolean"
},
"error": {
"description": "The error message of http request",
"type": "string"
},
"data": {
"description": "The testing result",
"type": "boolean"
},
"extra": {
"description": "The extra info",
"type": "string"
}
}
}
Test FTP server ¶
GET/v6_1/ftps/test/{ftpId}
Test ftp server of specific FTP server id.
200
Body
{
"success": "true",
"error": "",
"data": "true",
"extra": ""
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "The status of http request",
"type": "boolean"
},
"error": {
"description": "The error message of http request",
"type": "string"
},
"data": {
"description": "The testing result",
"type": "boolean"
},
"extra": {
"description": "The extra info",
"type": "string"
}
}
}
DNS Server Management ¶
Retrieve List - DNS server profile by query criteria ¶
POST/v6_1/profiles/dnsserver/query
Use this API command to retrieve a list of DNS server profile by query criteria. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "a0a77450-e9da-11e6-952e-64006a6a50c6",
"name": "ruckDNS",
"description": "",
"primaryIp": "1.5.2.2",
"secondaryIp": "",
"tertiaryIp": null,
"createDateTime": 1486103588885,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486103588885,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {
"rbacMetadata": [
{
"WLAN_CATEGORY": "FULL_ACCESS"
}
]
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for User Traffic profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the dns server service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the dns server service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primaryIp": {
"description": "Primary ip of DNS server service",
"type": "string"
},
"secondaryIp": {
"description": "Secondary ip of DNS server service",
"type": "string"
},
"tertiaryIp": {
"description": "Tertiary ip of DNS server service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"id": {
"description": "Profile Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Delete a list of DNS server profile ¶
DELETE/v6_1/profiles/dnsserver
Use this API command to delete a list of DNS server profile.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Retrieve list ¶
GET/v6_1/profiles/dnsserver
Use this API command to retrieve a list of DNS server profile.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "a0a77450-e9da-11e6-952e-64006a6a50c6",
"name": "ruckDNS",
"description": "",
"primaryIp": "1.5.2.2",
"secondaryIp": "",
"tertiaryIp": null,
"createDateTime": 1486103588885,
"modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"modifiedDateTime": 1486103588885,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {
"rbacMetadata": [
{
"WLAN_CATEGORY": "FULL_ACCESS"
}
]
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for User Traffic profile",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the dns server service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the dns server service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primaryIp": {
"description": "Primary ip of DNS server service",
"type": "string"
},
"secondaryIp": {
"description": "Secondary ip of DNS server service",
"type": "string"
},
"tertiaryIp": {
"description": "Tertiary ip of DNS server service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"id": {
"description": "Profile Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/profiles/dnsserver/{id}
Use this API command to retrieve DNS server profile.
200
Body
{
"name": "DNS server name",
"description": "DNS server description",
"primaryIp": "172.17.60.61",
"secondaryIp": "172.17.60.53",
"tertiaryIp": "172.17.60.50"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the dns server service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the dns server service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primaryIp": {
"description": "Primary ip of DNS server service",
"type": "string"
},
"secondaryIp": {
"description": "Secondary ip of DNS server service",
"type": "string"
},
"tertiaryIp": {
"description": "Tertiary ip of DNS server service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"id": {
"description": "Profile Id",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create ¶
POST/v6_1/profiles/dnsserver
Use this API command to create DNS server profile.
Body
{
"name": "DNS server name",
"description": "DNS server description",
"primaryIp": "172.17.60.61",
"secondaryIp": "172.17.60.53",
"tertiaryIp": "172.17.60.50"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the dns server service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the dns server service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primaryIp": {
"description": "Primary ip of DNS server service",
"type": "string"
},
"secondaryIp": {
"description": "Secondary ip of DNS server service",
"type": "string"
},
"tertiaryIp": {
"description": "Tertiary ip of DNS server service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
}
},
"required": [
"name",
"primaryIp"
]
}
201
Body
{
"id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/profiles/dnsserver/{id}
Use this API command to modify the basic information of DNS server profile.
Body
{
"name": "DNS server name",
"description": "DNS server description",
"primaryIp": "172.17.60.61",
"secondaryIp": "172.17.60.53",
"tertiaryIp": "172.17.60.50"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the dns server service",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the dns server service",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primaryIp": {
"description": "Primary ip of DNS server service",
"type": "string"
},
"secondaryIp": {
"description": "Secondary ip of DNS server service",
"type": "string"
},
"tertiaryIp": {
"description": "Tertiary ip of DNS server service",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"domainId": {
"description": "Domain UUID",
"type": "string"
},
"id": {
"description": "Profile Id",
"type": "string"
}
}
}
204
Delete ¶
Clone ¶
POST/v6_1/profiles/dnsserver/clone/{id}
Use this API command to clone an DNS server profile.
Body
{
"oldId": "839f87c6-d116-497e-afce-aa8157abdasd",
"newName": "new name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"oldName": {
"description": "original name",
"type": "string"
},
"oldId": {
"description": "original name",
"type": "string"
},
"newName": {
"description": "Id for new profile",
"type": "string"
},
"newId": {
"description": "name for new profile",
"type": "string"
}
}
}
200
Body
{
"oldId": "839f87c6-d116-497e-afce-aa8157abdasd",
"newId": "fe171501-ad2c-11e5-b656-5254003f0277",
"oldName": "old name",
"newName": "new name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"oldName": {
"description": "original name",
"type": "string"
},
"oldId": {
"description": "original name",
"type": "string"
},
"newName": {
"description": "Id for new profile",
"type": "string"
},
"newId": {
"description": "name for new profile",
"type": "string"
}
}
}
SMS Gateway ¶
Get SMS gateway ¶
GET/v6_1/smsGateway
Get SMS gateway.
- domainId
string
(optional)MSP/Partner domain id of the SMS gateway
200
Body
{
"id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
"serverType": "Twilio",
"enabled": 1,
"serverName": "Twilio SMS server",
"accountSid": "My SID",
"authToken": "My Token",
"from": "Ruckus"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "SMS Id",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": [
"string",
"null"
]
},
"serverType": {
"description": "Server type",
"enum": [
"Twilio"
]
},
"enabled": {
"description": "Enabled SMS server or not",
"enum": [
0,
1
]
},
"serverName": {
"description": "Server Name",
"type": "string"
},
"accountSid": {
"description": "Account SID",
"type": "string"
},
"authToken": {
"description": "Auth Token",
"type": "string"
},
"from": {
"description": "From",
"type": "string"
}
}
}
Update SMS gateway ¶
PATCH/v6_1/smsGateway
Update SMS gateway.
Body
{
"id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
"serverType": "Twilio",
"enabled": 1,
"serverName": "Twilio SMS server",
"accountSid": "My SID",
"authToken": "My Token",
"from": "Ruckus"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "SMS Id",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": [
"string",
"null"
]
},
"serverType": {
"description": "Server type",
"enum": [
"Twilio"
]
},
"enabled": {
"description": "Enabled SMS server or not",
"enum": [
0,
1
]
},
"serverName": {
"description": "Server Name",
"type": "string"
},
"accountSid": {
"description": "Account SID",
"type": "string"
},
"authToken": {
"description": "Auth Token",
"type": "string"
},
"from": {
"description": "From",
"type": "string"
}
}
}
200
Query SMS gateway ¶
POST/v6_1/smsGateway/query
Query SMS gateway. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": true,
"firstIndex": 0,
"list": [
{
"id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
"serverType": "Twilio",
"enabled": 1,
"serverName": "Twilio SMS server",
"accountSid": "My SID",
"authToken": "My Token",
"from": "Ruckus"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total SMS gateway count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more SMS gateway after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first SMS gateway returned out of the complete SMS gateway list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "SMS Id",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": [
"string",
"null"
]
},
"serverType": {
"description": "Server type",
"enum": [
"Twilio"
]
},
"enabled": {
"description": "Enabled SMS server or not",
"enum": [
0,
1
]
},
"serverName": {
"description": "Server Name",
"type": "string"
},
"accountSid": {
"description": "Account SID",
"type": "string"
},
"authToken": {
"description": "Auth Token",
"type": "string"
},
"from": {
"description": "From",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
Application Log And Status ¶
Retrieve List ¶
GET/v6_1/applications/{bladeUUID}
Use this API command to retrieve a list of application log and status.
- 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
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"applicationName": "API",
"healthStatus": "Online",
"logLevel": "WARN",
"numOfLogs": 1,
"logFileNames": [
"api.log"
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"applicationName": {
"description": "Application name",
"type": "string"
},
"healthStatus": {
"description": "Health status",
"type": "string"
},
"logLevel": {
"description": "Log level",
"type": "string"
},
"numOfLogs": {
"description": "# of Logs",
"type": "integer"
},
"logFileNames": {
"description": "List of log file name",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
Get control plane list ¶
GET/v5_0/applications/controlplane
Use this API command to retrieve a list of control plane.
Deprecated : this URI will be deprecated after Version: v5_0, not support.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"cpUUID": "9db2975b-1af2-4153-b400-b7f094058b4f",
"cpName": "R-KVM-200-C"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"cpUUID": {
"description": "Identifier of control plane",
"type": "string"
},
"cpName": {
"description": "Name of control plane",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Modify Log Level ¶
PATCH/v6_1/applications
Use this API command to modify log level of specified application.
Body
{
"applicationName": "API",
"logLevel": "WARN"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"applicationName": {
"description": "Application name.",
"type": "string"
},
"logLevel": {
"description": "Log level.",
"enum": [
"DEBUG",
"INFO",
"WARN",
"ERROR"
]
}
}
}
204
Identity User ¶
Retrieve Identity User List ¶
GET/v6_1/identity/users
Use this API command to retrieve a list of identity user.
- 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
- timeZone
string
(optional)Display created date and time by specified time zone. Default is UTC.
- userName
string
(optional)filter identity user list by user name.
- displayName
string
(optional)filter identity user list by display name.
- firstName
string
(optional)filter identity user list by first name.
- lastName
string
(optional)filter identity user list by last name.
string
(optional)filter identity user list by email.
- phone
string
(optional)filter identity user list by phone.
- userType
string
(optional)filter identity user list by user type.
- userSource
string
(optional)filter identity user list by user source.
- isDisabled
string
(optional)filter identity user list by isDisabled.
- createdOnFrom
string
(optional)filter identity user list by created date and time. The start time of created date and time.
- createdOnTo
string
(optional)filter identity user list by created date and time. The end time of created date and time.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "09115c82-a049-4609-8fd8-1100b875592d",
"displayName": "display name",
"userName": "user name",
"userSource": "Local Database",
"userType": "LOCAL",
"isDisabled": "NO",
"createdOn": "2015/09/25 15:49:37"
},
{
"id": "b5f02dbf-c769-436d-ae2d-44a6af194b57",
"displayName": "display name",
"userName": "user name",
"userSource": "Local Database",
"userType": "LOCAL",
"isDisabled": "NO",
"createdOn": "2015/09/23 16:35:44"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for identity user",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the identity user",
"type": "string"
},
"displayName": {
"description": "Display name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"userName": {
"description": "User Name",
"type": "string"
},
"userSource": {
"description": "User Source",
"type": "string"
},
"userType": {
"description": "User Type",
"type": "string"
},
"isDisabled": {
"description": "Is disalbed",
"type": "string"
},
"createdOn": {
"description": "Created on",
"type": "string"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Retrieve Identity User List ¶
POST/v6_1/identity/userList
Use this API command to retrieve a list of identity user.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "09115c82-a049-4609-8fd8-1100b875592d",
"displayName": "display name",
"userName": "user name",
"userSource": "Local Database",
"userType": "LOCAL",
"isDisabled": "NO",
"createdOn": "2015/09/25 15:49:37"
},
{
"id": "b5f02dbf-c769-436d-ae2d-44a6af194b57",
"displayName": "display name",
"userName": "user name",
"userSource": "Local Database",
"userType": "LOCAL",
"isDisabled": "NO",
"createdOn": "2015/09/23 16:35:44"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for identity user",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the identity user",
"type": "string"
},
"displayName": {
"description": "Display name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"userName": {
"description": "User Name",
"type": "string"
},
"userSource": {
"description": "User Source",
"type": "string"
},
"userType": {
"description": "User Type",
"type": "string"
},
"isDisabled": {
"description": "Is disalbed",
"type": "string"
},
"createdOn": {
"description": "Created on",
"type": "string"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Retrieve AAAServer List ¶
GET/v6_1/identity/users/aaaserver
Use this API command to retrieve a list of aaa server.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "94b5c120-6014-11e5-b24f-525400c0e1b3",
"name": "globalRadius"
},
{
"id": "11111111-1111-1111-1111-111111111111",
"name": "Local Database"
}
]
}
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": "the identifier of the AAA server",
"type": "string"
},
"name": {
"description": "the identifier of the AAA server",
"type": "string"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Retrieve Package List ¶
GET/v6_1/identity/users/packages
Use this API command to retrieve a list of packages.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"subscriberPackage": {
"id": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "External User Package"
},
"packageExpiration": "2 Years",
"packageExpirationDate": 1482915055600
},
{
"subscriberPackage": {
"id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489",
"name": "Local User Package"
},
"packageExpiration": "Never Expires"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"subscriberPackage": {
"description": "Subscriber package",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"packageExpiration": {
"description": "Package expiration interval and value",
"type": "string"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Retrieve Country List ¶
GET/v6_1/identity/users/countries
Use this API command to retrieve a list of countries.
200
Body
{
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"countryShortName": "HU",
"countryName": "HUNGARY"
},
{
"countryShortName": "AE",
"countryName": "UNITED ARAB EMIRATES"
},
{
"countryShortName": "UZ",
"countryName": "UZBEKISTAN"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"countryShortName": {
"description": "Short name of country",
"type": "string"
},
"countryName": {
"description": "Full name of country",
"type": "string"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/identity/users/{id}
Use this API command to retrieve identity user.
200
Body
{
"userName": "username",
"password": "",
"firstName": "firstname",
"lastName": "lastname",
"email": "[email protected]",
"phone": "99-999-9999",
"address": "address",
"city": "city name",
"state": "state name",
"zipCode": "zip code",
"countryName": "TAIWAN",
"countryShortName": "TW",
"remark": "remark description",
"subscriberPackage": {
"id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489",
"name": "Local User Package"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"firstName": {
"description": "First name",
"type": "string",
"minLength": 2,
"maxLength": 32
},
"lastName": {
"description": "Last Name",
"type": "string",
"minLength": 2,
"maxLength": 32
},
"email": {
"description": "Email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string",
"minLength": 2,
"maxLength": 32
},
"address": {
"description": "Address",
"type": "string",
"minLength": 2,
"maxLength": 256
},
"city": {
"description": "City",
"type": "string",
"minLength": 2,
"maxLength": 50
},
"state": {
"description": "State",
"type": "string",
"minLength": 2,
"maxLength": 32
},
"zipCode": {
"description": "Zip Code",
"type": "string",
"minLength": 2,
"maxLength": 32
},
"countryName": {
"description": "Country",
"type": "string"
},
"countryShortName": {
"description": "Country",
"type": "string"
},
"remark": {
"description": "Remark",
"type": "string",
"minLength": 2,
"maxLength": 32
},
"userName": {
"description": "User Name",
"type": "string",
"minLength": 2,
"maxLength": 64
},
"subscriberPackage": {
"description": "Subscriber package",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"isDisabled": {
"description": "Is Disabled",
"enum": [
"NO",
"YES"
]
},
"packageStatus": {
"description": "Package Status",
"enum": [
"DEPLETED",
"AVAILABLE",
"EXPIRED",
"TERMINATED",
"REMOVED"
]
},
"packageExpirationInterval": {
"description": "Package Expiration Interval",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR",
"NEVER"
]
},
"packageExpirationValue": {
"description": "Package Expiration Value",
"type": "integer"
},
"packageExpirationDate": {
"description": "Package Expiration Date",
"type": "integer"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
},
"usernamePasswordCredentialsImplDto": {
"description": "",
"type": "object",
"additionalProperties": false,
"properties": {
"loginName": {
"description": "Login Name",
"type": "string"
},
"loginPassword": {
"description": "Login Password",
"type": "string"
},
"key": {
"description": "identifier of the UsernamePasswordCredentialsImplDto",
"type": "string"
},
"serviceProviderId": {
"description": "Service Provider Id",
"type": "string"
},
"creationDate": {
"description": "Creation Date",
"type": "integer"
},
"expirationDate": {
"description": "Expiration Date",
"type": "integer"
},
"authenticationMethod": {
"description": "Authentication Method",
"enum": [
"USERNAME_PASSWORD",
"GUEST_PASS",
"MAC_WLAN_DPSK",
"MO",
"REMOTE",
"OAUTH2"
]
},
"authenticationServerConfig": {
"description": "Server configuration",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "server id",
"type": "string"
},
"name": {
"description": "server name",
"type": "string"
},
"type": {
"description": "server type",
"type": "string"
},
"local": {
"description": "Is local server",
"type": "boolean"
},
"AUTHENTICATION_SERVER_TYPE": {
"description": "Authentication server type",
"enum": [
"authenticationServerType"
]
},
"AUTHENTICATION_SERVER_NAME": {
"description": "Authentication server name",
"enum": [
"authenticationServerName"
]
},
"AUTHENTICATION_SERVER_ID": {
"description": "Authentication server id",
"enum": [
"authenticationServerId"
]
}
}
},
"passwordCreation": {
"description": "Creation Date of Password",
"type": "string"
},
"passwordExpiration": {
"description": "Expiration Date of Password",
"type": "string"
}
}
},
"credentialsGuestPassDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"authenticationMethod": {
"description": "Authentication method of credential",
"enum": [
"GUEST_PASS"
]
},
"key": {
"description": "Key of this guest pass",
"type": "string"
},
"serviceProviderId": {
"description": "Service Provider Id",
"type": "string"
},
"creationDate": {
"description": "Creation Date",
"type": "integer"
},
"expirationDate": {
"description": "Expiration date and time",
"type": "string"
},
"userKey": {
"description": "user ID of the identity guest pass",
"type": "string"
},
"userName": {
"description": "Username of this guest pass",
"type": "string"
},
"displayName": {
"description": "filter identity user list by display name",
"type": "string"
},
"loginPassword": {
"description": "Login Password",
"type": "string"
},
"guestExpiration": {
"description": "Expiration time of guest pass",
"type": "integer"
},
"wlan": {
"description": "WLAN Id",
"type": "string"
},
"wlanName": {
"description": "WLAN Name",
"type": "string"
},
"maxDevices": {
"description": "Maximum number of allowed device",
"type": "integer"
},
"expirationValue": {
"type": "integer"
},
"expirationUnit": {
"enum": [
"HOUR",
"DAY",
"WEEK"
]
},
"sessionUnit": {
"enum": [
"MIN",
"HOUR",
"DAY",
"WEEK"
]
},
"sessionValue": {
"type": "integer"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
},
"expireAfterIfNotUsed": {
"type": "integer"
},
"macAddressList": {
"type": "array"
},
"autoGeneratePassword": {
"description": "Pass generation",
"type": "boolean"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"comment": {
"type": "string"
}
}
}
}
}
Create ¶
POST/v6_1/identity/users
Use this API command to create identity user.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"firstName": "first name",
"lastName": "last name",
"email": "[email protected]",
"phone": "999-9-9999999",
"address": "address",
"city": "city",
"state": "state",
"zipCode": "11023",
"countryName": "TAIWAN",
"countryShortName": "TW",
"remark": "remark description",
"userName": "ruckus",
"password": "password",
"isDisabled": "NO",
"subscriberPackage": {
"id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"firstName": {
"description": "First name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"email": {
"description": "Email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"zipCode": {
"description": "Zip Code",
"type": "string"
},
"countryName": {
"description": "Country",
"type": "string"
},
"countryShortName": {
"description": "Country",
"type": "string"
},
"isDisabled": {
"description": "Is Disabled",
"enum": [
"NO",
"YES"
]
},
"remark": {
"description": "Remark",
"type": "string"
},
"userName": {
"description": "User Name",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"domainId": {
"description": "Domain ID",
"type": "string"
},
"subscriberPackage": {
"description": "Subscriber package",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"firstName",
"lastName",
"isDisabled",
"userName",
"password"
]
}
201
Body
{
"id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/identity/users/{id}
Use this API command to modify the basic information of identity user.
Body
{
"firstName": "first name",
"lastName": "last name",
"email": "[email protected]",
"phone": "999-9-9999999",
"address": "address",
"city": "city",
"state": "state",
"zipCode": "11023",
"countryName": "TAIWAN",
"countryShortName": "TW",
"remark": "remark description",
"userName": "ruckus",
"password": "password",
"subscriberPackage": {
"id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"firstName": {
"description": "First name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"email": {
"description": "Email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"zipCode": {
"description": "Zip Code",
"type": "string"
},
"countryName": {
"description": "Country",
"type": "string"
},
"countryShortName": {
"description": "Country",
"type": "string"
},
"isDisabled": {
"description": "Is Disabled",
"enum": [
"NO",
"YES"
]
},
"remark": {
"description": "Remark",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"subscriberPackage": {
"description": "Subscriber package",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
204
Modify Subscriber Package ¶
PATCH/v6_1/identity/users/{id}/subscriberPackage
Use this API command to modify subscriber package.
Body
{
"id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489"
}
Schema
{
"description": "Subscriber package",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
204
Delete Multiple Identity Users ¶
DELETE/v6_1/identity/users
Use this API command to delete multiple identity users.
Body
{
"idList": [
"b5f02dbf-c769-436d-ae2d-44a6af194b57",
"839f87c6-d116-497e-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Identity Guest Pass ¶
Retrieve Identity Guest Pass List ¶
GET/v6_1/identity/guestpass
Use this API command to retrieve a list of identity guest pass.
- 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
- timeZone
string
(optional)Display created date and time by specified time zone. Default is UTC.
- wlan
string
(optional)filter identity guest pass list by wlan id.
- displayName
string
(optional)filter identity guest pass list by display name.
- expirationFrom
string
(optional)filter identity guest pass list by expiration date and time. The start time of expiration date and time.The format is yyyy-MM-dd HH:mm:ss.
- expirationTo
string
(optional)filter identity guest pass list by expiration date and time. The end time of expiration date and time.The format is yyyy-MM-dd HH:mm:ss.
- generatedTimeFrom
string
(optional)filter identity guest pass list by generated date and time. The start time of generated date and time.The format is yyyy-MM-dd HH:mm:ss.
- generatedTimeTo
string
(optional)filter identity guest pass list by generated date and time. The end time of generated date and time.The format is yyyy-MM-dd HH:mm:ss.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "24cfb9af-4b3f-4d0a-8a92-b2eba022687b",
"userId": "afdfc09e-ef23-4d93-8598-8ed95fe67460",
"key": "6ygwR3B2",
"guestName": "guest-name-1",
"remarks": "remark",
"generatedOn": "2015/10/26 10:19:30",
"expirationDate": "2015/10/27 10:19:30",
"wlanRestrition": "[wlan-name] of [zone-name]"
},
{
"id": "b28ff2cc-e0f6-4e58-b520-46b29be613ea",
"userId": "ab96f27b-1145-4371-85c6-1c1eaa9aff6f",
"key": "J8cjtQM9",
"guestName": "guest-name-2",
"remarks": "remark",
"generatedOn": "2015/10/26 09:54:36",
"expirationDate": "2015/10/27 00:54:36",
"wlanRestrition": "[wlan-name] of [zone-name]"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for GuestPass",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID of the identity guest pass",
"type": "string"
},
"userId": {
"description": "user ID of the identity guest pass",
"type": "string"
},
"key": {
"description": "Identifier of the identity guest pass",
"type": "string"
},
"guestName": {
"description": "Guest name of the identity guest pass",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"wlan": {
"description": "wlan",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"zone": {
"description": "zone",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"ssid": {
"description": "SSID",
"type": "string"
},
"passValidFor": {
"description": "Pass valid for",
"type": "object",
"additionalProperties": false,
"properties": {
"expirationValue": {
"type": "integer"
},
"expirationUnit": {
"enum": [
"HOUR",
"DAY",
"WEEK"
]
}
}
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"autoGeneratedPassword": {
"description": "Pass generation",
"type": "boolean"
},
"passEffectSince": {
"description": "Pass effective since",
"enum": [
"CREATION_TIME",
"FIRST_USE"
]
},
"passUseDays": {
"description": "Expire new guest pass if not used within",
"type": "integer"
},
"remarks": {
"description": "Remarks",
"type": "string"
},
"generatedOn": {
"description": "Generated date and time",
"type": "string"
},
"expirationDate": {
"description": "Expiration date and time",
"type": "string"
},
"wlanRestrition": {
"description": "Wlan description",
"type": "string"
},
"sessionDuration": {
"description": "session duration",
"type": "object",
"additionalProperties": false,
"properties": {
"requireLoginAgain": {
"type": "boolean"
},
"sessionValue": {
"type": "integer"
},
"sessionUnit": {
"enum": [
"MIN",
"HOUR",
"DAY",
"WEEK"
]
}
}
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Retrieve Identity Guest Pass List ¶
POST/v6_1/identity/guestpassList
Use this API command to retrieve a list of identity guest pass.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "24cfb9af-4b3f-4d0a-8a92-b2eba022687b",
"userId": "afdfc09e-ef23-4d93-8598-8ed95fe67460",
"key": "6ygwR3B2",
"guestName": "guest-name-1",
"remarks": "remark",
"generatedOn": "2015/10/26 10:19:30",
"expirationDate": "2015/10/27 10:19:30",
"wlanRestrition": "[wlan-name] of [zone-name]"
},
{
"id": "b28ff2cc-e0f6-4e58-b520-46b29be613ea",
"userId": "ab96f27b-1145-4371-85c6-1c1eaa9aff6f",
"key": "J8cjtQM9",
"guestName": "guest-name-2",
"remarks": "remark",
"generatedOn": "2015/10/26 09:54:36",
"expirationDate": "2015/10/27 00:54:36",
"wlanRestrition": "[wlan-name] of [zone-name]"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for GuestPass",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID of the identity guest pass",
"type": "string"
},
"userId": {
"description": "user ID of the identity guest pass",
"type": "string"
},
"key": {
"description": "Identifier of the identity guest pass",
"type": "string"
},
"guestName": {
"description": "Guest name of the identity guest pass",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"wlan": {
"description": "wlan",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"zone": {
"description": "zone",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"ssid": {
"description": "SSID",
"type": "string"
},
"passValidFor": {
"description": "Pass valid for",
"type": "object",
"additionalProperties": false,
"properties": {
"expirationValue": {
"type": "integer"
},
"expirationUnit": {
"enum": [
"HOUR",
"DAY",
"WEEK"
]
}
}
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"autoGeneratedPassword": {
"description": "Pass generation",
"type": "boolean"
},
"passEffectSince": {
"description": "Pass effective since",
"enum": [
"CREATION_TIME",
"FIRST_USE"
]
},
"passUseDays": {
"description": "Expire new guest pass if not used within",
"type": "integer"
},
"remarks": {
"description": "Remarks",
"type": "string"
},
"generatedOn": {
"description": "Generated date and time",
"type": "string"
},
"expirationDate": {
"description": "Expiration date and time",
"type": "string"
},
"wlanRestrition": {
"description": "Wlan description",
"type": "string"
},
"sessionDuration": {
"description": "session duration",
"type": "object",
"additionalProperties": false,
"properties": {
"requireLoginAgain": {
"type": "boolean"
},
"sessionValue": {
"type": "integer"
},
"sessionUnit": {
"enum": [
"MIN",
"HOUR",
"DAY",
"WEEK"
]
}
}
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Generate Identity Guest Pass ¶
POST/v6_1/identity/guestpass/generate
Use this API command to generate identity guest pass.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"guestName": "guest name",
"wlan": {
"name": "wlan name"
},
"zone": {
"name": "zone name"
},
"numberOfPasses": 1,
"passValidFor": {
"expirationValue": 15,
"expirationUnit": "HOUR"
},
"autoGeneratedPassword": true,
"passEffectSince": "CREATION_TIME",
"passUseDays": 7,
"maxDevices": {
"maxDevicesAllowed": "LIMITED",
"maxDevicesNumber": 3
},
"sessionDuration": {
"requireLoginAgain": true,
"sessionValue": 3,
"sessionUnit": "DAY"
},
"remarks": "comment"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"type": "string",
"description": "Domain Id"
},
"guestName": {
"description": "Guest name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"wlan": {
"description": "wlan id",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"zone": {
"description": "zone id",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"numberOfPasses": {
"description": "Number of passes",
"type": "integer"
},
"passValidFor": {
"description": "Pass valid for",
"type": "object",
"additionalProperties": false,
"properties": {
"expirationValue": {
"type": "integer"
},
"expirationUnit": {
"enum": [
"HOUR",
"DAY",
"WEEK"
]
}
}
},
"autoGeneratedPassword": {
"description": "Pass generation",
"type": "boolean"
},
"passValue": {
"description": "Pass value",
"type": "string"
},
"passEffectSince": {
"description": "Pass effective since",
"enum": [
"CREATION_TIME",
"FIRST_USE"
]
},
"passUseDays": {
"description": "Expire new guest pass if not used within",
"type": "integer"
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"sessionDuration": {
"description": "session duration",
"type": "object",
"additionalProperties": false,
"properties": {
"requireLoginAgain": {
"type": "boolean"
},
"sessionValue": {
"type": "integer"
},
"sessionUnit": {
"enum": [
"MIN",
"HOUR",
"DAY",
"WEEK"
]
}
}
},
"remarks": {
"description": "Remarks",
"type": "string"
}
},
"required": [
"guestName",
"wlan",
"zone",
"numberOfPasses",
"passValidFor",
"maxDevices"
]
}
201
Body
{
"id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Import Identity Guest Pass ¶
POST/v6_1/identity/guestpass/upload
Use this API command to upload identity guest pass csv file.
200
Common Identity Guest Pass Settings ¶
POST/v6_1/identity/guestpass/upload/common
Use this API command to update common identity guest pass settings.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"wlan": {
"name": "wlan name"
},
"zone": {
"name": "zone name"
},
"passValidFor": {
"expirationValue": 15,
"expirationUnit": "HOUR"
},
"passEffectSince": "CREATION_TIME",
"passUseDays": 7,
"maxDevices": {
"maxDevicesAllowed": "LIMITED",
"maxDevicesNumber": 3
},
"sessionDuration": {
"requireLoginAgain": true,
"sessionValue": 3,
"sessionUnit": "DAY"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Domain Id",
"type": "string"
},
"wlan": {
"description": "wlan id",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"zone": {
"description": "zone id",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"passValidFor": {
"description": "Pass valid for",
"type": "object",
"additionalProperties": false,
"properties": {
"expirationValue": {
"type": "integer"
},
"expirationUnit": {
"enum": [
"HOUR",
"DAY",
"WEEK"
]
}
}
},
"passEffectSince": {
"description": "Pass effective since",
"enum": [
"CREATION_TIME",
"FIRST_USE"
]
},
"passUseDays": {
"description": "Expire new guest pass if not used within",
"type": "integer"
},
"maxDevices": {
"description": "max Devices",
"type": "object",
"additionalProperties": false,
"properties": {
"maxDevicesAllowed": {
"description": "Max devices allowed",
"enum": [
"UNLIMITED",
"LIMITED"
],
"default": "LIMITED"
},
"maxDevicesNumber": {
"description": "max devices number",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 10
}
}
},
"sessionDuration": {
"description": "session duration",
"type": "object",
"additionalProperties": false,
"properties": {
"requireLoginAgain": {
"type": "boolean"
},
"sessionValue": {
"type": "integer"
},
"sessionUnit": {
"enum": [
"MIN",
"HOUR",
"DAY",
"WEEK"
]
}
}
}
},
"required": [
"wlan",
"zone",
"passValidFor",
"maxDevices"
]
}
201
Delete ¶
DELETE/v6_1/identity/guestpass/{userId}
Use this API command to delete identity guest pass.
204
Delete Multiple Identity Guest Passes ¶
DELETE/v6_1/identity/guestpass
Use this API command to delete multiple identity guest passes.
Body
{
"idList": [
"b5f02dbf-c769-436d-ae2d-44a6af194b57",
"839f87c6-d116-497e-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Identity Subscription Package ¶
Retrieve subscription package list ¶
GET/v6_1/identity/packages
Use this API command to retrieve a list of subscription package.
200
Body
{
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "24cfb9af-4b3f-4d0a-8a92-b2eba022687b",
"name": "subscription-package-name1",
"description": "description",
"expirationInterval": "HOUR",
"expirationValue": 8
},
{
"id": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "External User Package",
"description": "External User Package",
"expirationInterval": "YEAR",
"expirationValue": 2
},
{
"id": "6547be7c-6787-487e-b672-f90faf77b6d0",
"name": "Local User Package",
"description": "Local User Package",
"expirationInterval": "NEVER",
"expirationValue": 0
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for subscription package",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the subscription package",
"type": "string"
},
"name": {
"description": "name of the subscription package",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the subscription package",
"type": [
"string",
"null"
],
"maxLength": 64
},
"expirationInterval": {
"description": "Expiration interval",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR",
"NEVER"
]
},
"expirationValue": {
"description": "Expiration value",
"type": "integer"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Retrieve subscription package list ¶
POST/v6_1/identity/packageList
Use this API command to retrieve a list of subscription package.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "24cfb9af-4b3f-4d0a-8a92-b2eba022687b",
"name": "subscription-package-name1",
"description": "description",
"expirationInterval": "HOUR",
"expirationValue": 8
},
{
"id": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "External User Package",
"description": "External User Package",
"expirationInterval": "YEAR",
"expirationValue": 2
},
{
"id": "6547be7c-6787-487e-b672-f90faf77b6d0",
"name": "Local User Package",
"description": "Local User Package",
"expirationInterval": "NEVER",
"expirationValue": 0
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for subscription package",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the subscription package",
"type": "string"
},
"name": {
"description": "name of the subscription package",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the subscription package",
"type": [
"string",
"null"
],
"maxLength": 64
},
"expirationInterval": {
"description": "Expiration interval",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR",
"NEVER"
]
},
"expirationValue": {
"description": "Expiration value",
"type": "integer"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/identity/packages/{id}
Use this API command to retrieve subscription package.
200
Body
{
"name": "subscription-package-name",
"description": "description",
"expirationInterval": "DAY",
"expirationValue": 3
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the subscription package",
"type": [
"string",
"null"
],
"maxLength": 64
},
"expirationInterval": {
"description": "Expiration interval",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR",
"NEVER"
]
},
"expirationValue": {
"description": "Expiration value",
"type": "integer"
},
"domainId": {
"description": "identifier of the domain",
"type": "string"
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Create ¶
POST/v6_1/identity/packages
Use this API command to create subscription package.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "subscription-package-name",
"description": "description",
"expirationInterval": "HOUR",
"expirationValue": 5
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "name of subscription package",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the subscription package",
"type": [
"string",
"null"
],
"maxLength": 64
},
"expirationInterval": {
"description": "Expiration interval",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR",
"NEVER"
]
},
"expirationValue": {
"description": "Expiration value",
"type": "integer"
}
},
"required": [
"name",
"expirationInterval",
"expirationValue"
]
}
201
Body
{
"id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
Modify ¶
PATCH/v6_1/identity/packages/{id}
Use this API command to modify the basic information of subscription package.
Body
{
"name": "subscription-package-name",
"description": "description",
"expirationInterval": "DAY",
"expirationValue": 3
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"domainId": {
"description": "Domain Id",
"type": "string"
},
"name": {
"description": "name of subscription package",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description of the subscription package",
"type": [
"string",
"null"
],
"maxLength": 64
},
"expirationInterval": {
"description": "Expiration interval",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR",
"NEVER"
]
},
"expirationValue": {
"description": "Expiration value",
"type": "integer"
}
}
}
204
Delete ¶
Delete ¶
DELETE/v6_1/identity/packages
Use this API command to delete multiple subscription packages.
Body
{
"idList": [
"b5f02dbf-c769-436d-ae2d-44a6af194b57",
"839f87c6-d116-497e-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Connectivity Tools ¶
SpeedFlex ¶
POST/v6_1/tool/speedflex
Use this API command to start the SpeedFlex test.
Body
{
"tool": "ZAP_DOWN",
"protocol": "UDP",
"model": "AP",
"clientIp": "1.1.1.1",
"clientMac": "00:11:22:33:44:55",
"serverIp": "2.2.2.2",
"serverMac": "11:22:33:44:55:66",
"syspmtu": 1500
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"tool": {
"description": "SpeedFlex tool",
"enum": [
"ZAP_DOWN",
"ZAP_UP"
]
},
"protocol": {
"description": "Protocol used in the SpeedFlex test",
"enum": [
"UDP",
"TCP"
]
},
"model": {
"description": "Test model",
"enum": [
"AP",
"CLIENT",
"TRACE",
"HOP",
"NULL"
]
},
"clientIp": {
"description": "The HTTP request remove address is used if none is specified",
"type": "string"
},
"clientMac": {
"description": "The HTTP request remove MAC address is used if none is specified",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"serverIp": {
"description": "The AP IP address is resolved from the client IP address if none is specified",
"type": "string"
},
"serverMac": {
"description": "The AP MAC address is resolved from the client MAC address if none is specified",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"syspmtu": {
"description": "Default: 1500",
"type": "integer"
}
},
"required": [
"tool",
"protocol"
]
}
200
Body
{
"wcid": "123",
"resultId": 11,
"uplink": 33,
"downlink": 44,
"latency": 23,
"packetLoss": 21,
"etf": 21
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"wcid": {
"descriptin": "WCID",
"type": "string"
},
"resultId": {
"description": "Result ID",
"type": "integer"
},
"uplink": {
"description": "Uplink",
"type": "integer"
},
"downlink": {
"description": "Downlink",
"type": "integer"
},
"latency": {
"description": "Latency",
"type": "integer"
},
"packetLoss": {
"description": "Packet loss",
"type": "integer"
},
"etf": {
"description": "ETF",
"type": "integer"
}
}
}
Retrieve SppedFlex Results ¶
GET/v6_1/tool/speedflex/{wcid}
Use this API command to retrieve existing SpeedFlex test results.
200
Body
{
"wcid": "123",
"resultId": 11,
"uplink": 33,
"downlink": 44,
"latency": 23,
"packetLoss": 21,
"etf": 21
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"wcid": {
"descriptin": "WCID",
"type": "string"
},
"resultId": {
"description": "Result ID",
"type": "integer"
},
"uplink": {
"description": "Uplink",
"type": "integer"
},
"downlink": {
"description": "Downlink",
"type": "integer"
},
"latency": {
"description": "Latency",
"type": "integer"
},
"packetLoss": {
"description": "Packet loss",
"type": "integer"
},
"etf": {
"description": "ETF",
"type": "integer"
}
}
}
Ping ¶
GET/v6_1/tool/ping
Use this API command to run the PING test on an AP.
- apMac
string
(required)MAC address of the AP running the PING test
- targetIP
string
(required)the IP address to PING
200
Trace Route ¶
GET/v6_1/tool/traceRoute
Use this API command to run the traceroute test on an AP.
- apMac
string
(required)MAC address of the AP running the traceRoute test
- targetIP
string
(required)the target IP address to traceRoute
- timeoutInSec
string
(optional)Timeout in unit of seconds (Default: 30)
200
SCG User ¶
Add SCG user ¶
POST/v6_1/users
Add SCG user.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"userName": "user1",
"realName": "John",
"passphrase": "admin!234",
"phone": "123456",
"email": "[email protected]",
"title": "CEO"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
200
Body
{
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG user",
"type": "string"
}
}
}
Get SCG user ¶
GET/v6_1/users/{userId}
Get SCG user.
200
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"userName": "user1",
"realName": "John",
"passphrase": "admin!234",
"phone": "123456",
"email": "[email protected]",
"title": "CEO"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Query SCG users ¶
POST/v6_1/users/query
Query SCG users. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"DOMAIN"
]
},
"value": {
"description": "DOMAIN ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq"
]
}
},
"required": [
"type",
"value"
]
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"userName": "user1",
"passphrase": null,
"realName": "john",
"title": "CEO",
"phone": "123456",
"email": "[email protected]",
"enabled": 1,
"locked": 0,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"companyName": "ruckus",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
]
}
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": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
Update SCG user ¶
PATCH/v6_1/users/{userId}
Update SCG user.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"userName": "user1",
"realName": "John",
"passphrase": "admin!234",
"phone": "123456",
"email": "[email protected]",
"title": "CEO"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
200
Body
{
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG user",
"type": "string"
}
}
}
Delete SCG user ¶
DELETE/v6_1/users/{userId}
Delete SCG user.
204
Body
{
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG user",
"type": "string"
}
}
}
Delete SCG user ¶
DELETE/v6_1/users
Delete multiple SCG user.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
200
SCG User Group ¶
Add SCG user group ¶
POST/v6_1/userGroups
Add SCG user group.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "group1",
"description": "",
"role": "AP_ADMIN",
"accountSecurityProfileId": "a51ghnqa-1002-80a9-3a6b-ba00a0ddez9",
"permissions": [
{
"resource": "AP_CATEGORY",
"access": "MODIFY"
},
{
"resource": "WLAN_CATEGORY",
"access": "MODIFY"
},
{
"resource": "DEVICE_CATEGORY",
"access": "READ"
}
],
"resourceGroups": [
{
"type": "DOMAIN",
"id": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"users": [
{
"userName": "user1",
"realName": "john",
"title": "CEO",
"phone": "123456",
"email": "[email protected]",
"enabled": 1,
"locked": 0,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"companyName": "ruckus",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User group Id",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": [
"string",
"null"
]
},
"domainId": {
"description": "Domain Id",
"type": [
"string",
"null"
]
},
"name": {
"description": "User group name",
"type": "string"
},
"description": {
"description": "User group description",
"type": [
"string",
"null"
]
},
"role": {
"description": "User group role",
"type": [
"string",
"null"
]
},
"accountSecurityProfileId": {
"description": "scguser.scgUserGroup.properties.accountSecurityProfileId.description",
"type": "string"
},
"accountSecurityProfileName": {
"description": "scguser.scgUserGroup.properties.accountSecurityProfileName.description",
"type": "string"
},
"permissions": {
"description": "Permission list",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"description": "Resource type",
"type": "string"
},
"access": {
"description": "Access level",
"enum": [
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"description": "Resource display name",
"type": "string"
},
"ids": {
"description": "Resource id list",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
}
},
"resourceGroups": {
"description": "Resource group id list",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG resource group",
"type": "string"
},
"type": {
"description": "the type of SCG resource group",
"enum": [
"DOMAIN",
"ZONE",
"APGROUP"
]
},
"name": {
"description": "the name of the SCG resource group",
"type": "string"
}
}
}
},
"users": {
"description": "Users in this user group",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"name",
"role",
"accountSecurityProfileId",
"permissions",
"resourceGroups"
]
}
201
Body
{
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG user group",
"type": "string"
}
}
}
Delete SCG user group ¶
DELETE/v6_1/userGroups/{userGroupId}
Delete SCG user group.
204
Body
{
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG user group",
"type": "string"
}
}
}
Delete SCG user group ¶
DELETE/v6_1/userGroups
Delete multiple SCG user group.
Body
{
"idList": [
"1c942d00-4f36-11e6-8512-0a0027000000",
"0a782052-96d5-738b-afce-aa8157abd30c"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
200
Get SCG user group ¶
GET/v6_1/userGroups/{userGroupId}
Get SCG user group.
- includeUsers
string
(optional)
200
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "group1",
"description": "",
"role": "AP_ADMIN",
"accountSecurityProfileId": "a51ghnqa-1002-80a9-3a6b-ba00a0ddez9",
"permissions": [
{
"resource": "AP_CATEGORY",
"access": "MODIFY"
},
{
"resource": "WLAN_CATEGORY",
"access": "MODIFY"
},
{
"resource": "DEVICE_CATEGORY",
"access": "READ"
}
],
"resourceGroups": [
{
"type": "DOMAIN",
"id": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"users": [
{
"userName": "user1",
"realName": "john",
"title": "CEO",
"phone": "123456",
"email": "[email protected]",
"enabled": 1,
"locked": 0,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"companyName": "ruckus",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User group Id",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": [
"string",
"null"
]
},
"domainId": {
"description": "Domain Id",
"type": [
"string",
"null"
]
},
"name": {
"description": "User group name",
"type": "string"
},
"description": {
"description": "User group description",
"type": [
"string",
"null"
]
},
"role": {
"description": "User group role",
"type": [
"string",
"null"
]
},
"accountSecurityProfileId": {
"description": "scguser.scgUserGroup.properties.accountSecurityProfileId.description",
"type": "string"
},
"accountSecurityProfileName": {
"description": "scguser.scgUserGroup.properties.accountSecurityProfileName.description",
"type": "string"
},
"permissions": {
"description": "Permission list",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"description": "Resource type",
"type": "string"
},
"access": {
"description": "Access level",
"enum": [
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"description": "Resource display name",
"type": "string"
},
"ids": {
"description": "Resource id list",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
}
},
"resourceGroups": {
"description": "Resource group id list",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG resource group",
"type": "string"
},
"type": {
"description": "the type of SCG resource group",
"enum": [
"DOMAIN",
"ZONE",
"APGROUP"
]
},
"name": {
"description": "the name of the SCG resource group",
"type": "string"
}
}
}
},
"users": {
"description": "Users in this user group",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"name",
"role",
"accountSecurityProfileId",
"permissions",
"resourceGroups"
]
}
Get permitted categories of current user ¶
GET/v6_1/userGroups/currentUser/permissionCategories
Get permitted categories of current user.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"resource": "GUESTPASS_CATEGORY",
"access": "FULL_ACCESS",
"items": [
{
"resource": "IDENTITY_USER",
"access": "FULL_ACCESS",
"display": "Identity user"
},
{
"resource": "GUESTPASS",
"access": "FULL_ACCESS",
"display": "Guestpass"
},
{
"resource": "GUEST_TEMPLATE",
"access": "FULL_ACCESS",
"display": "Guest template"
}
],
"itemsDescription": [
"Guest Passes",
"Local Users"
],
"display": "Guest Pass"
}
],
"extra": {
"isSuperAdminOfDomain": true,
"isSuperAdmin": true
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"description": "Resource type",
"type": "string"
},
"access": {
"description": "Access level",
"enum": [
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"description": "Resource display name",
"type": "string"
},
"items": {
"description": "Resource items",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"type": "string"
},
"access": {
"enum": [
"NA",
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"type": "string"
}
}
}
},
"itemsDescription": {
"description": "Descriptions of Resource items",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"ids": {
"description": "Resource id list",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
},
"extra": {
"description": "Any additional response data.",
"type": "object",
"properties": {
"isSuperAdmin": {
"description": "whether or not current user is a 'Super Admin' that possesses all 6 permission categories with 'FULL_ACCESS'",
"type": "boolean"
},
"isSuperAdminOfDomain": {
"description": "whether or not current user is a 'Super Admin of Partner Domain' that possesses all 6 permission categories with 'FULL_ACCESS'",
"type": "boolean"
}
}
}
}
}
Get pre-defined roles ¶
GET/v6_1/userGroups/roles
Get pre-defined roles.
200
Body
{
"totalCount": 8,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"label": "Super Admin",
"value": "SUPER_ADMIN"
},
{
"label": "System Admin",
"value": "SYSTEM_ADMIN"
},
{
"label": "Read-Only System Admin",
"value": "RO_SYSTEM_ADMIN"
},
{
"label": "Network Admin",
"value": "NETWORK_ADMIN"
},
{
"label": "Read-Only Network Admin",
"value": "RO_NETWORK_ADMIN"
},
{
"label": "AP Admin",
"value": "AP_ADMIN"
},
{
"label": "Guest Pass Admin",
"value": "GUEST_PASS_ADMIN"
},
{
"label": "Custom",
"value": "CUSTOM"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"label": {
"description": "Role display name",
"type": "string"
},
"value": {
"description": "Role value",
"type": "string"
}
}
}
}
}
}
Get permission items of role ¶
GET/v6_1/userGroups/roles/{role}/permissions
Get permission items of role.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"resource": "GUESTPASS_CATEGORY",
"access": "FULL_ACCESS",
"items": [
{
"resource": "IDENTITY_USER",
"access": "FULL_ACCESS",
"display": "Identity user"
},
{
"resource": "GUESTPASS",
"access": "FULL_ACCESS",
"display": "Guestpass"
},
{
"resource": "GUEST_TEMPLATE",
"access": "FULL_ACCESS",
"display": "Guest template"
}
],
"itemsDescription": [
"Guest Passes",
"Local Users"
],
"display": "Guest Pass"
}
],
"extra": {
"isSuperAdminOfDomain": true,
"isSuperAdmin": true
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"description": "Resource type",
"type": "string"
},
"access": {
"description": "Access level",
"enum": [
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"description": "Resource display name",
"type": "string"
},
"items": {
"description": "Resource items",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"type": "string"
},
"access": {
"enum": [
"NA",
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"type": "string"
}
}
}
},
"itemsDescription": {
"description": "Descriptions of Resource items",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"ids": {
"description": "Resource id list",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
},
"extra": {
"description": "Any additional response data.",
"type": "object",
"properties": {
"isSuperAdmin": {
"description": "whether or not current user is a 'Super Admin' that possesses all 6 permission categories with 'FULL_ACCESS'",
"type": "boolean"
},
"isSuperAdminOfDomain": {
"description": "whether or not current user is a 'Super Admin of Partner Domain' that possesses all 6 permission categories with 'FULL_ACCESS'",
"type": "boolean"
}
}
}
}
}
Query user groups ¶
POST/v6_1/userGroups/query
Query user groups. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"DOMAIN"
]
},
"value": {
"description": "DOMAIN ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq"
]
}
},
"required": [
"type",
"value"
]
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "group1",
"description": "",
"role": "AP_ADMIN",
"permissions": [
{
"resource": "AP_CATEGORY",
"access": "MODIFY"
},
{
"resource": "WLAN_CATEGORY",
"access": "MODIFY"
},
{
"resource": "DEVICE_CATEGORY",
"access": "READ"
}
],
"resourceGroups": [
{
"type": "DOMAIN",
"id": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"users": [
{
"userName": "user1",
"realName": "john",
"title": "CEO",
"phone": "123456",
"email": "[email protected]",
"enabled": 1,
"locked": 0,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"companyName": "ruckus",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
]
}
]
}
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": "User group Id",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": [
"string",
"null"
]
},
"domainId": {
"description": "Domain Id",
"type": [
"string",
"null"
]
},
"name": {
"description": "User group name",
"type": "string"
},
"description": {
"description": "User group description",
"type": [
"string",
"null"
]
},
"role": {
"description": "User group role",
"type": [
"string",
"null"
]
},
"accountSecurityProfileId": {
"description": "scguser.scgUserGroup.properties.accountSecurityProfileId.description",
"type": "string"
},
"accountSecurityProfileName": {
"description": "scguser.scgUserGroup.properties.accountSecurityProfileName.description",
"type": "string"
},
"permissions": {
"description": "Permission list",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"description": "Resource type",
"type": "string"
},
"access": {
"description": "Access level",
"enum": [
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"description": "Resource display name",
"type": "string"
},
"ids": {
"description": "Resource id list",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
}
},
"resourceGroups": {
"description": "Resource group id list",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG resource group",
"type": "string"
},
"type": {
"description": "the type of SCG resource group",
"enum": [
"DOMAIN",
"ZONE",
"APGROUP"
]
},
"name": {
"description": "the name of the SCG resource group",
"type": "string"
}
}
}
},
"users": {
"description": "Users in this user group",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"name",
"role",
"accountSecurityProfileId",
"permissions",
"resourceGroups"
]
}
},
"extra": {
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
Update user groups ¶
PATCH/v6_1/userGroups/{userGroupId}
Update user groups.
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "scguser.patchScgUserGroup.properties.id.description",
"type": "string"
},
"tenantId": {
"description": "scguser.patchScgUserGroup.properties.tenantId.description",
"type": [
"string",
"null"
]
},
"domainId": {
"description": "scguser.patchScgUserGroup.properties.domainId.description",
"type": [
"string",
"null"
]
},
"name": {
"description": "scguser.patchScgUserGroup.properties.name.description",
"type": "string"
},
"description": {
"description": "scguser.patchScgUserGroup.properties.description.description",
"type": [
"string",
"null"
]
},
"role": {
"description": "scguser.patchScgUserGroup.properties.role.description",
"type": [
"string",
"null"
]
},
"accountSecurityProfileId": {
"description": "scguser.patchScgUserGroup.properties.accountSecurityProfileId.description",
"type": "string"
},
"permissions": {
"description": "scguser.patchScgUserGroup.properties.permissions.description",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"description": "Resource type",
"type": "string"
},
"access": {
"description": "Access level",
"enum": [
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"description": "Resource display name",
"type": "string"
},
"ids": {
"description": "Resource id list",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
}
},
"resourceGroups": {
"description": "scguser.patchScgUserGroup.properties.resourceGroups.description",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG resource group",
"type": "string"
},
"type": {
"description": "the type of SCG resource group",
"enum": [
"DOMAIN",
"ZONE",
"APGROUP"
]
},
"name": {
"description": "the name of the SCG resource group",
"type": "string"
}
}
}
},
"users": {
"description": "scguser.patchScgUserGroup.properties.users.description",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
},
"createDateTime": {
"description": "scguser.patchScgUserGroup.properties.createDateTime.description",
"type": "integer"
},
"modifiedDateTime": {
"description": "scguser.patchScgUserGroup.properties.modifiedDateTime.description",
"type": "integer"
},
"creatorId": {
"description": "scguser.patchScgUserGroup.properties.creatorId.description",
"type": "string"
},
"modifierId": {
"description": "scguser.patchScgUserGroup.properties.modifierId.description",
"type": "string"
},
"creatorUsername": {
"description": "scguser.patchScgUserGroup.properties.creatorUsername.description",
"type": "string"
},
"modifierUsername": {
"description": "scguser.patchScgUserGroup.properties.modifierUsername.description",
"type": "string"
}
}
}
204
Body
{
"id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG user group",
"type": "string"
}
}
}
Update permissions of user groups ¶
PATCH/v6_1/userGroups/{userGroupId}/permissions
Update permissions of user groups.
Schema
{
"description": "scguser.patchScgUserGroup.properties.permissions.description",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"description": "Resource type",
"type": "string"
},
"access": {
"description": "Access level",
"enum": [
"READ",
"MODIFY",
"FULL_ACCESS"
]
},
"display": {
"description": "Resource display name",
"type": "string"
},
"ids": {
"description": "Resource id list",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
}
}
204
Update permission scope of user groups ¶
PATCH/v6_1/userGroups/{userGroupId}/resourceGroups
Update permission scope of user groups.
Schema
{
"description": "scguser.patchScgUserGroup.properties.resourceGroups.description",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the SCG resource group",
"type": "string"
},
"type": {
"description": "the type of SCG resource group",
"enum": [
"DOMAIN",
"ZONE",
"APGROUP"
]
},
"name": {
"description": "the name of the SCG resource group",
"type": "string"
}
}
}
}
204
Update user list of user groups ¶
PATCH/v6_1/userGroups/{userGroupId}/users
Update user list of user groups.
Schema
{
"description": "scguser.patchScgUserGroup.properties.users.description",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "User id",
"type": "string"
},
"tenantUUID": {
"description": "Tenant id",
"type": "string"
},
"domainId": {
"description": "Domain id",
"type": "string"
},
"userName": {
"description": "User name",
"type": "string"
},
"passphrase": {
"description": "User login passphrase",
"type": [
"string",
"null"
]
},
"realName": {
"description": "User real name",
"type": [
"string",
"null"
]
},
"title": {
"description": "User title",
"type": [
"string",
"null"
]
},
"phone": {
"description": "User phone",
"type": [
"string",
"null"
]
},
"email": {
"description": "User email",
"type": [
"string",
"null"
]
},
"enabled": {
"description": "User enabled or not",
"enum": [
0,
1
]
},
"locked": {
"description": "User locked or not (0:unlocked/1:locked)",
"enum": [
0,
1
]
},
"companyName": {
"description": "User company name",
"type": [
"string",
"null"
]
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
}
204
IndoorMap ¶
Create IndoorMap ¶
POST/v6_1/maps
Use this API command to create indoorMap.
Body
{
"key": "",
"name": "MapName",
"description": "Description",
"address": "Location",
"latitude": "25.07858",
"longitude": "121.57141",
"orientation": "HORIZONTAL",
"imageData": "The base64 encoded data of image",
"imageFileName": "map.jpg",
"scale": {
"a": {
"x": 252.6392059326172,
"y": 187.01136779785156
},
"b": {
"x": 360.63922119140625,
"y": 184.01136779785156
},
"distance": 3,
"unit": "M"
},
"inputItem": "",
"groupType": "ZONE",
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "id",
"type": "string"
},
"zoneId": {
"description": "zoneId",
"type": "string"
},
"name": {
"description": "name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"groupType": {
"description": "group Type",
"enum": [
"SYSTEM",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP"
]
},
"address": {
"description": "address",
"type": "string"
},
"latitude": {
"description": "latitude",
"type": "number"
},
"longitude": {
"description": "longitude",
"type": "number"
},
"orientation": {
"description": "orientation",
"enum": [
"HORIZONTAL",
"VERTICAL"
]
},
"imageData": {
"description": "imageData",
"type": "string"
},
"imageFileName": {
"description": "imageFileName",
"type": "string"
},
"domainId": {
"description": "domainId",
"type": "string"
},
"tenantId": {
"description": "tenantId",
"type": "string"
},
"scale": {
"description": "scale",
"type": "object",
"additionalProperties": false,
"properties": {
"a": {
"description": "point a",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"b": {
"description": "point b",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"distance": {
"description": "distance",
"type": "number"
},
"unit": {
"description": "unit",
"enum": [
"MM",
"CM",
"M",
"Foot",
"Yard"
]
}
}
},
"apGroupId": {
"description": "apGroupId",
"type": "string"
}
},
"required": [
"name",
"description",
"groupType"
]
}
201
Body
{
"id": "c9167ee0-2568-11e6-b2ac-0a0027000000",
"name": "mapName"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the indoor map",
"type": "string"
},
"name": {
"description": "the name of the indoor map",
"type": "string"
}
}
}
Delete IndoorMap ¶
DELETE/v6_1/maps/{indoorMapId}
Use this API command to delete indoor map.
204
Body
{
"id": "c9167ee0-2568-11e6-b2ac-0a0027000000",
"name": "mapName"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the indoor map",
"type": "string"
},
"name": {
"description": "the name of the indoor map",
"type": "string"
}
}
}
Get IndoorMap ¶
GET/v6_1/maps/{indoorMapId}
Use this API command to get indoor maps.
200
Body
{
"key": "",
"name": "MapName",
"description": "Description",
"address": "Location",
"latitude": "25.07858",
"longitude": "121.57141",
"orientation": "HORIZONTAL",
"imageData": "The base64 encoded data of image",
"imageFileName": "map.jpg",
"scale": {
"a": {
"x": 252.6392059326172,
"y": 187.01136779785156
},
"b": {
"x": 360.63922119140625,
"y": 184.01136779785156
},
"distance": 3,
"unit": "M"
},
"inputItem": "",
"groupType": "ZONE",
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "id",
"type": "string"
},
"zoneId": {
"description": "zoneId",
"type": "string"
},
"name": {
"description": "name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"groupType": {
"description": "group Type",
"enum": [
"SYSTEM",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP"
]
},
"address": {
"description": "address",
"type": "string"
},
"latitude": {
"description": "latitude",
"type": "number"
},
"longitude": {
"description": "longitude",
"type": "number"
},
"orientation": {
"description": "orientation",
"enum": [
"HORIZONTAL",
"VERTICAL"
]
},
"imageData": {
"description": "imageData",
"type": "string"
},
"imageFileName": {
"description": "imageFileName",
"type": "string"
},
"domainId": {
"description": "domainId",
"type": "string"
},
"tenantId": {
"description": "tenantId",
"type": "string"
},
"scale": {
"description": "scale",
"type": "object",
"additionalProperties": false,
"properties": {
"a": {
"description": "point a",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"b": {
"description": "point b",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"distance": {
"description": "distance",
"type": "number"
},
"unit": {
"description": "unit",
"enum": [
"MM",
"CM",
"M",
"Foot",
"Yard"
]
}
}
},
"apGroupId": {
"description": "apGroupId",
"type": "string"
}
},
"required": [
"name",
"description",
"groupType"
]
}
Update indoor map ¶
PATCH/v6_1/maps/{indoorMapId}
Use this API command to update specific indoor map.
Body
{
"key": "",
"name": "MapName",
"description": "Description",
"address": "Location",
"latitude": "25.07858",
"longitude": "121.57141",
"orientation": "HORIZONTAL",
"imageData": "The base64 encoded data of image",
"imageFileName": "map.jpg",
"scale": {
"a": {
"x": 252.6392059326172,
"y": 187.01136779785156
},
"b": {
"x": 360.63922119140625,
"y": 184.01136779785156
},
"distance": 3,
"unit": "M"
},
"inputItem": "",
"groupType": "ZONE",
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "id",
"type": "string"
},
"zoneId": {
"description": "zoneId",
"type": "string"
},
"name": {
"description": "name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"groupType": {
"description": "group Type",
"enum": [
"SYSTEM",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP"
]
},
"address": {
"description": "address",
"type": "string"
},
"latitude": {
"description": "latitude",
"type": "number"
},
"longitude": {
"description": "longitude",
"type": "number"
},
"orientation": {
"description": "orientation",
"enum": [
"HORIZONTAL",
"VERTICAL"
]
},
"imageData": {
"description": "imageData",
"type": "string"
},
"imageFileName": {
"description": "imageFileName",
"type": "string"
},
"domainId": {
"description": "domainId",
"type": "string"
},
"tenantId": {
"description": "tenantId",
"type": "string"
},
"scale": {
"description": "scale",
"type": "object",
"additionalProperties": false,
"properties": {
"a": {
"description": "point a",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"b": {
"description": "point b",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"distance": {
"description": "distance",
"type": "number"
},
"unit": {
"description": "unit",
"enum": [
"MM",
"CM",
"M",
"Foot",
"Yard"
]
}
}
},
"apGroupId": {
"description": "apGroupId",
"type": "string"
}
},
"required": [
"name",
"description",
"groupType"
]
}
204
Body
{
"id": "c9167ee0-2568-11e6-b2ac-0a0027000000",
"name": "mapName"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the indoor map",
"type": "string"
},
"name": {
"description": "the name of the indoor map",
"type": "string"
}
}
}
Update indoor map ¶
PATCH/v6_1/maps/{indoorMapId}/scale
Use this API command to update the scale of specific indoor map.
Body
{
"a": {
"x": 252.6392059326172,
"y": 187.01136779785156
},
"b": {
"x": 360.63922119140625,
"y": 184.01136779785156
},
"distance": 3,
"unit": "M"
}
Schema
{
"description": "scale",
"type": "object",
"additionalProperties": false,
"properties": {
"a": {
"description": "point a",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"b": {
"description": "point b",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"distance": {
"description": "distance",
"type": "number"
},
"unit": {
"description": "unit",
"enum": [
"MM",
"CM",
"M",
"Foot",
"Yard"
]
}
}
}
204
Get indoor map list ¶
GET/v6_1/maps
Use this API command to get indoor map list.
- groupId
string
(required)- groupType
string
(required)
200
Body
{
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"key": "93b59041-1e97-4048-be43-4909553c78b6",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "DemoMap",
"description": "",
"imageFileName": "map.png",
"orientation": "HORIZONTAL",
"address": "350 W Java Dr Sunnyvale, CA 94089",
"longitude": -122.0196,
"latitude": 37.41121,
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"groupType": "ZONE",
"scale": {
"a": {
"x": 341.99716,
"y": 224.01706
},
"b": {
"x": 418.99716,
"y": 202.01706
},
"distance": 2,
"unit": "CM"
}
},
{
"key": "3608b441-256a-11e6-b2ac-0a0027000000",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "MapName",
"description": "Description",
"imageFileName": "z82FU.gif",
"orientation": "HORIZONTAL",
"address": "Location",
"longitude": 121.57141,
"latitude": 25.07858,
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"groupType": "ZONE",
"scale": {
"a": {
"x": 252.6392,
"y": 187.01137
},
"b": {
"x": 360.63922,
"y": 184.01137
},
"distance": 3,
"unit": "M"
}
},
{
"key": "c9167ee0-2568-11e6-b2ac-0a0027000000",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "name",
"description": "",
"imageFileName": "download.jpg",
"orientation": "HORIZONTAL",
"address": "Address",
"longitude": 121.57141,
"latitude": 25.07858,
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"groupType": "ZONE",
"scale": {
"a": {
"x": 279.0199,
"y": 160.01706
},
"b": {
"x": 413.0199,
"y": 159.01706
},
"distance": 5,
"unit": "MM"
}
}
],
"extra": null
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total indoor maps count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more indoor maps after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first indoorMapList returned out of the complete indoor maps list",
"type": "integer"
},
"extra": {
"description": "extra information for indoor map",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "indoorMap.basicIndoorMap.properties.id.description",
"type": "string"
},
"zoneId": {
"description": "indoorMap.basicIndoorMap.properties.zoneId.description",
"type": "string"
},
"name": {
"description": "indoorMap.basicIndoorMap.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "indoorMap.basicIndoorMap.properties.description.description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"groupType": {
"description": "indoorMap.basicIndoorMap.properties.groupType.description",
"enum": [
"SYSTEM",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP"
]
},
"address": {
"description": "indoorMap.basicIndoorMap.properties.address.description",
"type": "string"
},
"latitude": {
"description": "indoorMap.basicIndoorMap.properties.latitude.description",
"type": "number"
},
"longitude": {
"description": "indoorMap.basicIndoorMap.properties.longitude.description",
"type": "number"
},
"orientation": {
"description": "indoorMap.basicIndoorMap.properties.orientation.description",
"enum": [
"HORIZONTAL",
"VERTICAL"
]
},
"imageFileName": {
"description": "indoorMap.basicIndoorMap.properties.imageFileName.description",
"type": "string"
},
"domainId": {
"description": "indoorMap.basicIndoorMap.properties.domainId.description",
"type": "string"
},
"tenantId": {
"description": "indoorMap.basicIndoorMap.properties.tenantId.description",
"type": "string"
},
"scale": {
"description": "indoorMap.basicIndoorMap.properties.scale.description",
"type": "object",
"additionalProperties": false,
"properties": {
"a": {
"description": "point a",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"b": {
"description": "point b",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"distance": {
"description": "distance",
"type": "number"
},
"unit": {
"description": "unit",
"enum": [
"MM",
"CM",
"M",
"Foot",
"Yard"
]
}
}
},
"apGroupId": {
"description": "indoorMap.basicIndoorMap.properties.apGroupId.description",
"type": "string"
}
},
"required": [
"name",
"description",
"groupType"
]
}
}
}
}
Put Aps in indoor map ¶
PUT/v6_1/maps/{indoorMapId}/aps
Use this API command to put Aps in indoor map.
Body
[
{
"mac": "AB:CD:00:00:00:27",
"indoorMapXy": {
"x": 142.16,
"y": 89.61
}
}
]
Schema
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "the identifier of the create object",
"type": "string"
},
"indoorMapXy": {
"description": "location of this AP",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
}
}
}
}
204
Body
{
"id": "c9167ee0-2568-11e6-b2ac-0a0027000000",
"name": "mapName"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the indoor map",
"type": "string"
},
"name": {
"description": "the name of the indoor map",
"type": "string"
}
}
}
Query IndoorMap ¶
POST/v6_1/maps/query
Use this API command to query indoorMap. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"key": "93b59041-1e97-4048-be43-4909553c78b6",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "DemoMap",
"description": "",
"imageFileName": "map.png",
"orientation": "HORIZONTAL",
"address": "350 W Java Dr Sunnyvale, CA 94089",
"longitude": -122.0196,
"latitude": 37.41121,
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"groupType": "ZONE",
"scale": {
"a": {
"x": 341.99716,
"y": 224.01706
},
"b": {
"x": 418.99716,
"y": 202.01706
},
"distance": 2,
"unit": "CM"
}
},
{
"key": "3608b441-256a-11e6-b2ac-0a0027000000",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "MapName",
"description": "Description",
"imageFileName": "z82FU.gif",
"orientation": "HORIZONTAL",
"address": "Location",
"longitude": 121.57141,
"latitude": 25.07858,
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"groupType": "ZONE",
"scale": {
"a": {
"x": 252.6392,
"y": 187.01137
},
"b": {
"x": 360.63922,
"y": 184.01137
},
"distance": 3,
"unit": "M"
}
},
{
"key": "c9167ee0-2568-11e6-b2ac-0a0027000000",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "name",
"description": "",
"imageFileName": "download.jpg",
"orientation": "HORIZONTAL",
"address": "Address",
"longitude": 121.57141,
"latitude": 25.07858,
"zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"groupType": "ZONE",
"scale": {
"a": {
"x": 279.0199,
"y": 160.01706
},
"b": {
"x": 413.0199,
"y": 159.01706
},
"distance": 5,
"unit": "MM"
}
}
],
"extra": null
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total indoor maps count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more indoor maps after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first indoorMapList returned out of the complete indoor maps list",
"type": "integer"
},
"extra": {
"description": "extra information for indoor map",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "indoorMap.basicIndoorMap.properties.id.description",
"type": "string"
},
"zoneId": {
"description": "indoorMap.basicIndoorMap.properties.zoneId.description",
"type": "string"
},
"name": {
"description": "indoorMap.basicIndoorMap.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "indoorMap.basicIndoorMap.properties.description.description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"groupType": {
"description": "indoorMap.basicIndoorMap.properties.groupType.description",
"enum": [
"SYSTEM",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP"
]
},
"address": {
"description": "indoorMap.basicIndoorMap.properties.address.description",
"type": "string"
},
"latitude": {
"description": "indoorMap.basicIndoorMap.properties.latitude.description",
"type": "number"
},
"longitude": {
"description": "indoorMap.basicIndoorMap.properties.longitude.description",
"type": "number"
},
"orientation": {
"description": "indoorMap.basicIndoorMap.properties.orientation.description",
"enum": [
"HORIZONTAL",
"VERTICAL"
]
},
"imageFileName": {
"description": "indoorMap.basicIndoorMap.properties.imageFileName.description",
"type": "string"
},
"domainId": {
"description": "indoorMap.basicIndoorMap.properties.domainId.description",
"type": "string"
},
"tenantId": {
"description": "indoorMap.basicIndoorMap.properties.tenantId.description",
"type": "string"
},
"scale": {
"description": "indoorMap.basicIndoorMap.properties.scale.description",
"type": "object",
"additionalProperties": false,
"properties": {
"a": {
"description": "point a",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"b": {
"description": "point b",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"distance": {
"description": "distance",
"type": "number"
},
"unit": {
"description": "unit",
"enum": [
"MM",
"CM",
"M",
"Foot",
"Yard"
]
}
}
},
"apGroupId": {
"description": "indoorMap.basicIndoorMap.properties.apGroupId.description",
"type": "string"
}
},
"required": [
"name",
"description",
"groupType"
]
}
}
}
}
Query With Filter ¶
Query APs ¶
POST/v6_1/query/ap
Query APs with specified filters Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 9,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"deviceName": "AP001",
"description": "Description",
"status": "Online",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:00",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": "10.10.10.33",
"extPort": "4000",
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": "ProvisionMethod1",
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720659798,
"managementVlan": null,
"configOverride": false,
"indoorMapId": "66479bc8-44c7-4f6b-b741-d4056b0305a7",
"apGroupId": "c9e43dad-cbcb-4f75-a804-2680ea4c0e80",
"indoorMapXy": {
"x": 368.4700012207031,
"y": 108.5
},
"indoorMapName": "DemoMap",
"indoorMapLocation": "350 W Java Dr Sunnyvale, CA 94089",
"deviceGps": null,
"connectionStatus": "Connect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
},
{
"deviceName": "AP002",
"description": "Description",
"status": "Online",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:01",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": "10.10.10.22",
"extPort": "2000",
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": "ProvisionMethod2",
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720660065,
"managementVlan": null,
"configOverride": false,
"indoorMapId": "66479bc8-44c7-4f6b-b741-d4056b0305a7",
"apGroupId": "c9e43dad-cbcb-4f75-a804-2680ea4c0e80",
"indoorMapXy": {
"x": 651.5499877929688,
"y": 273.9100036621094
},
"indoorMapName": "DemoMap",
"indoorMapLocation": "350 W Java Dr Sunnyvale, CA 94089",
"deviceGps": null,
"connectionStatus": "Connect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
},
{
"deviceName": "AP005",
"description": "Description",
"status": "Offline",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:04",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": "10.10.10.1",
"extPort": "4000",
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": "ProvisionMethod1",
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720660327,
"managementVlan": null,
"configOverride": false,
"indoorMapId": null,
"apGroupId": "2d01323d-6224-4de5-995b-e3311c767a74",
"indoorMapXy": null,
"indoorMapName": null,
"indoorMapLocation": null,
"deviceGps": null,
"connectionStatus": "Disconnect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
},
{
"deviceName": "AP006",
"description": "Description",
"status": "Offline",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:05",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": "10.10.10.22",
"extPort": "3000",
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": "ProvisionMethod1",
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720660388,
"managementVlan": null,
"configOverride": false,
"indoorMapId": null,
"apGroupId": "2d01323d-6224-4de5-995b-e3311c767a74",
"indoorMapXy": null,
"indoorMapName": null,
"indoorMapLocation": null,
"deviceGps": null,
"connectionStatus": "Disconnect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
},
{
"deviceName": "AP007",
"description": "Description",
"status": "Online",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:06",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": "10.10.10.1",
"extPort": "3000",
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": "ProvisionMethod1",
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720660452,
"managementVlan": null,
"configOverride": false,
"indoorMapId": null,
"apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
"indoorMapXy": null,
"indoorMapName": null,
"indoorMapLocation": null,
"deviceGps": null,
"connectionStatus": "Connect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
},
{
"deviceName": "AP008",
"description": "Description",
"status": "Online",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:07",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": "10.10.10.22",
"extPort": "3000",
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": "ProvisionMethod2",
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720660514,
"managementVlan": null,
"configOverride": false,
"indoorMapId": null,
"apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
"indoorMapXy": null,
"indoorMapName": null,
"indoorMapLocation": null,
"deviceGps": null,
"connectionStatus": "Connect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
},
{
"deviceName": "AP009",
"description": "Description",
"status": "Online",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:08",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": "10.10.10.1",
"extPort": "2000",
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": "ProvisionMethod2",
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720660583,
"managementVlan": null,
"configOverride": false,
"indoorMapId": null,
"apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
"indoorMapXy": null,
"indoorMapName": null,
"indoorMapLocation": null,
"deviceGps": null,
"connectionStatus": "Connect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
},
{
"deviceName": "AP054",
"description": "iYip7ido",
"status": "Online",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:35",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": null,
"extPort": null,
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": null,
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720663315,
"managementVlan": null,
"configOverride": false,
"indoorMapId": null,
"apGroupId": "df9a60ae-a69a-4a3f-a5b5-fa2657ae8494",
"indoorMapXy": null,
"indoorMapName": null,
"indoorMapLocation": null,
"deviceGps": null,
"connectionStatus": "Connect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
},
{
"deviceName": "AP055",
"description": "llEtjoXe",
"status": "Online",
"alerts": 0,
"ip": null,
"ipv6Address": null,
"txRx": null,
"noise24G": null,
"noise5G": null,
"airtime24G": null,
"airtime5G": null,
"latency24G": null,
"latency50G": null,
"capacity": null,
"capacity24G": null,
"capacity50G": null,
"connectionFailure": null,
"model": null,
"apMac": "AB:CD:00:00:00:36",
"channel24G": null,
"channel5G": null,
"meshRole": "DISABLED",
"meshMode": "Auto",
"zoneName": null,
"apGroupName": null,
"extIp": null,
"extPort": null,
"firmwareVersion": null,
"serial": null,
"retry24G": null,
"retry5G": null,
"configurationStatus": null,
"lastSeen": null,
"numClients": 0,
"numClients24G": 0,
"numClients5G": 0,
"tx": null,
"rx": null,
"location": null,
"wlanGroup24Id": null,
"wlanGroup50Id": null,
"wlanGroup24Name": null,
"wlanGroup50Name": null,
"enabledBonjourGateway": false,
"controlBladeName": null,
"lbsStatus": null,
"administrativeState": "Unlocked",
"registrationState": "Approved",
"provisionMethod": null,
"provisionStage": "PRE_AP_JOIN",
"registrationTime": 1484720663357,
"managementVlan": null,
"configOverride": false,
"indoorMapId": null,
"apGroupId": "df9a60ae-a69a-4a3f-a5b5-fa2657ae8494",
"indoorMapXy": null,
"indoorMapName": null,
"indoorMapLocation": null,
"deviceGps": null,
"connectionStatus": "Connect",
"zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"zoneFirmwareVersion": "3.5.0.102.79",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"domainName": null,
"dpIp": null,
"controlBladeId": null,
"isCriticalAp": false,
"crashDump": null,
"cableModemSupported": null,
"cableModemResetSupported": null,
"swapInMac": null,
"swapOutMac": null,
"isOverallHealthStatusFlagged": false,
"isLatency24GFlagged": false,
"isCapacity24GFlagged": false,
"isConnectionFailure24GFlagged": false,
"isLatency50GFlagged": false,
"isCapacity50GFlagged": false,
"isConnectionFailure50GFlagged": false,
"isConnectionTotalCountFlagged": false,
"isConnectionFailureFlagged": false,
"isAirtimeUtilization24GFlagged": false,
"isAirtimeUtilization50GFlagged": false,
"eirp24G": 20,
"eirp50G": 24,
"uptime": 123,
"ipsecRxBytes": 0,
"ipsecRxDropPkts": 0,
"ipsecRxIdleTime": 0,
"ipsecRxPkts": 0,
"ipsecSessionTime": 0,
"ipsecTxBytes": 0,
"ipsecTxDropPkts": 0,
"ipsecTxIdleTime": 0,
"ipsecTxPkts": 0,
"ipType": "IPV4"
}
],
"extra": {
"rbacMetadata": [
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
}
]
}
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for AP list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"registrationTime": {
"type": "integer"
},
"tx": {
"type": "integer"
},
"indoorMapId": {
"type": "string"
},
"channel24G": {
"type": "string"
},
"channel24gValue": {
"type": "Long"
},
"configOverride": {
"type": "boolean"
},
"deviceName": {
"type": "string"
},
"enabledBonjourGateway": {
"type": "boolean"
},
"numClients24G": {
"type": "integer"
},
"dataBladeName": {
"type": "string"
},
"retry24G": {
"type": "integer"
},
"airtime24G": {
"type": "integer"
},
"noise5G": {
"type": "integer"
},
"model": {
"type": "string"
},
"numClients": {
"type": "integer"
},
"capacity24G": {
"type": "integer"
},
"firmwareVersion": {
"type": "string"
},
"provisionMethod": {
"type": "string"
},
"latency24G": {
"type": "integer"
},
"retry5G": {
"type": "integer"
},
"ip": {
"type": "string"
},
"apMac": {
"type": "string"
},
"noise24G": {
"type": "integer"
},
"lastSeen": {
"type": "integer"
},
"configurationStatus": {
"type": "string"
},
"airtime5G": {
"type": "integer"
},
"alerts": {
"type": "integer"
},
"lbsStatus": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"Online",
"Offline",
"Flagged"
]
},
"numClients5G": {
"type": "integer"
},
"ipv6Address": {
"type": "string"
},
"capacity50G": {
"type": "integer"
},
"wlanGroup24Name": {
"type": "string"
},
"rx": {
"type": "integer"
},
"connectionFailure": {
"type": "number"
},
"description": {
"type": "string"
},
"capacity": {
"type": "integer"
},
"meshRole": {
"type": "string"
},
"channel5G": {
"type": "string"
},
"channel50gValue": {
"type": "Long"
},
"managementVlan": {
"type": "integer"
},
"wlanGroup50Name": {
"type": "string"
},
"wlanGroup24Id": {
"type": "string"
},
"controlBladeName": {
"type": "string"
},
"zoneName": {
"type": "string"
},
"txRx": {
"type": "integer"
},
"meshMode": {
"type": "string"
},
"extPort": {
"type": "string"
},
"administrativeState": {
"type": "string"
},
"apGroupName": {
"type": "string"
},
"latency50G": {
"type": "integer"
},
"indoorMapXy": {
"type": "object",
"additionalProperties": "false",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
}
},
"apGroupId": {
"type": "string"
},
"extIp": {
"type": "string"
},
"airtime": {
"type": "integer"
},
"provisionStage": {
"type": "string"
},
"indoorMapName": {
"type": "string"
},
"indoorMapLocation": {
"type": "string"
},
"deviceGps": {
"type": "string"
},
"serial": {
"type": "string"
},
"location": {
"type": "string"
},
"wlanGroup50Id": {
"type": "string"
},
"registrationState": {
"type": "string"
},
"zoneId": {
"type": "string"
},
"zoneFirmwareVersion": {
"type": "string"
},
"connectionStatus": {
"type": "string"
},
"domainId": {
"type": "string"
},
"domainName": {
"type": "string"
},
"dpIp": {
"type": "string"
},
"controlBladeId": {
"type": "string"
},
"isCriticalAp": {
"type": "boolean"
},
"crashDump": {
"type": "integer"
},
"cableModemSupported": {
"type": "boolean"
},
"cableModemResetSupported": {
"type": "boolean"
},
"swapInMac": {
"type": "string"
},
"swapOutMac": {
"type": "string"
},
"isOverallHealthStatusFlagged": {
"type": "boolean"
},
"isLatency24GFlagged": {
"type": "boolean"
},
"isCapacity24GFlagged": {
"type": "boolean"
},
"isConnectionFailure24GFlagged": {
"type": "boolean"
},
"isLatency50GFlagged": {
"type": "boolean"
},
"isCapacity50GFlagged": {
"type": "boolean"
},
"isConnectionFailure50GFlagged": {
"type": "boolean"
},
"isConnectionTotalCountFlagged": {
"type": "boolean"
},
"isConnectionFailureFlagged": {
"type": "boolean"
},
"isAirtimeUtilization24GFlagged": {
"type": "boolean"
},
"isAirtimeUtilization50GFlagged": {
"type": "boolean"
},
"eirp24G": {
"type": "integer"
},
"eirp50G": {
"type": "integer"
},
"uptime": {
"type": "integer"
},
"ipsecSessionTime": {
"type": "integer"
},
"ipsecTxPkts": {
"type": "integer"
},
"ipsecRxPkts": {
"type": "integer"
},
"ipsecTxBytes": {
"type": "integer"
},
"ipsecRxBytes": {
"type": "integer"
},
"ipsecTxDropPkts": {
"type": "integer"
},
"ipsecRxDropPkts": {
"type": "integer"
},
"ipsecTxIdleTime": {
"type": "integer"
},
"ipsecRxIdleTime": {
"type": "integer"
},
"ipType": {
"type": "string"
}
}
}
}
}
}
Query WLANs ¶
POST/v6_1/query/wlan
Query WLANs with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 5,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"name": "None",
"status": null,
"alerts": null,
"ssid": "None",
"authMethod": "OPEN",
"encryptionMethod": "NONE",
"clients": null,
"traffic": null,
"vlan": 1,
"applicationVisibility": "Disabled",
"tunneled": "APBridged",
"zeroITOnboard": "Disabled",
"zeroITEnabled": "Disabled",
"trafficUplink": null,
"trafficDownlink": null,
"enability11r": null,
"enability11k": null,
"description": "",
"wlanId": "5",
"wpaVersion": "",
"wepEncryptionStrength": 0,
"tenantId": "",
"tenantDomainName": ""
},
{
"name": "WEP128",
"status": null,
"alerts": null,
"ssid": "WEP128",
"authMethod": "OPEN",
"encryptionMethod": "WEP",
"clients": null,
"traffic": null,
"vlan": 1,
"applicationVisibility": "Disabled",
"tunneled": "APBridged",
"zeroITOnboard": "Disabled",
"zeroITEnabled": "Disabled",
"trafficUplink": null,
"trafficDownlink": null,
"enability11r": null,
"enability11k": null,
"description": "",
"wlanId": "4",
"wpaVersion": "WEP128",
"wepEncryptionStrength": 26,
"tenantId": "",
"tenantDomainName": ""
},
{
"name": "WEP64",
"status": null,
"alerts": null,
"ssid": "WEP64",
"authMethod": "OPEN",
"encryptionMethod": "WEP",
"clients": null,
"traffic": null,
"vlan": 1,
"applicationVisibility": "Disabled",
"tunneled": "APBridged",
"zeroITOnboard": "Disabled",
"zeroITEnabled": "Disabled",
"trafficUplink": null,
"trafficDownlink": null,
"enability11r": null,
"enability11k": null,
"description": "",
"wlanId": "3",
"wpaVersion": "WEP64",
"wepEncryptionStrength": 10,
"tenantId": "",
"tenantDomainName": ""
},
{
"name": "WPA-Mixed",
"status": null,
"alerts": null,
"ssid": "WPA-Mixed",
"authMethod": "OPEN",
"encryptionMethod": "WPA",
"clients": null,
"traffic": null,
"vlan": 1,
"applicationVisibility": "Disabled",
"tunneled": "APBridged",
"zeroITOnboard": "Disabled",
"zeroITEnabled": "Disabled",
"trafficUplink": null,
"trafficDownlink": null,
"enability11r": null,
"enability11k": null,
"description": "",
"wlanId": "2",
"wpaVersion": "AUTO",
"wepEncryptionStrength": 0,
"tenantId": "",
"tenantDomainName": ""
},
{
"name": "wpa2",
"status": null,
"alerts": null,
"ssid": "wpa2",
"authMethod": "OPEN",
"encryptionMethod": "WPA",
"clients": null,
"traffic": null,
"vlan": 1,
"applicationVisibility": "Disabled",
"tunneled": "APBridged",
"zeroITOnboard": "Disabled",
"zeroITEnabled": "Disabled",
"trafficUplink": null,
"trafficDownlink": null,
"enability11r": null,
"enability11k": null,
"description": "",
"wlanId": "1",
"wpaVersion": "WPA2",
"wepEncryptionStrength": 0,
"tenantId": "",
"tenantDomainName": ""
}
],
"extra": {
"rbacMetadata": [
{
"WLAN_CATEGORY": "FULL_ACCESS"
},
{
"WLAN_CATEGORY": "FULL_ACCESS"
},
{
"WLAN_CATEGORY": "FULL_ACCESS"
},
{
"WLAN_CATEGORY": "FULL_ACCESS"
},
{
"WLAN_CATEGORY": "FULL_ACCESS"
}
]
}
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for wlan list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"clients": {
"type": "integer"
},
"applicationVisibility": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"zeroITOnboard": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"trafficUplink": {
"type": "integer"
},
"description": {
"type": "string"
},
"zeroITEnabled": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"ssid": {
"type": "string"
},
"wlanId": {
"type": "string"
},
"encryptionMethod": {
"type": "string"
},
"enability11k": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"alerts": {
"type": "integer"
},
"tunneled": {
"type": "string",
"enum": [
"Tunneled",
"APBridged"
]
},
"vlan": {
"type": "integer"
},
"enability11r": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"name": {
"type": "string"
},
"authMethod": {
"type": "string"
},
"trafficDownlink": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"Online",
"Flagged",
"Offline"
]
},
"traffic": {
"type": "integer"
},
"wpaVersion": {
"type": "string"
},
"wepEncryptionStrength": {
"type": "integer"
},
"tenantId": {
"type": "string"
},
"tenantDomainName": {
"type": "string"
},
"utp": {
"type": "string"
}
}
}
}
}
}
Query AAAServers ¶
POST/v6_1/query/services/aaaServer
Query AAAServers with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"key": "fcdf29e1-e870-4950-a4df-57b80efb5811",
"type": "RADIUS",
"name": "aAAServer00001",
"description": null,
"authType": "WLAN",
"radiusRealm": "hinet.net",
"radiusIP": "172.17.1.1",
"radiusIPv6": null,
"radiusPort": 1812,
"secondaryRadiusIP": "172.18.16.1",
"secondaryRadiusIPv6": null,
"secondaryRadiusPort": 1111,
"enableSecondaryRadius": 1,
"isConflict": 0,
"tacacsService": null,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"ip": null,
"ipv6": null,
"port": null,
"adminDomainName": null,
"domainName": null,
"windowsDomainName": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createOn": 1484720653245,
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"globalCatalog": null,
"modifiedDateTime": 1484720653245,
"id": "fcdf29e1-e870-4950-a4df-57b80efb5811"
},
{
"key": "4d388f44-10dd-4563-91d7-5886ae0339a3",
"type": "RADIUS",
"name": "aAAServer00002",
"description": null,
"authType": "WLAN",
"radiusRealm": "hinet.net",
"radiusIP": "172.17.1.2",
"radiusIPv6": null,
"radiusPort": 1812,
"secondaryRadiusIP": "172.18.16.2",
"secondaryRadiusIPv6": null,
"secondaryRadiusPort": 1111,
"enableSecondaryRadius": 1,
"isConflict": 0,
"tacacsService": null,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"ip": null,
"ipv6": null,
"port": null,
"adminDomainName": null,
"domainName": null,
"windowsDomainName": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createOn": 1484720653245,
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"globalCatalog": null,
"modifiedDateTime": 1484720653245,
"id": "4d388f44-10dd-4563-91d7-5886ae0339a3"
}
],
"extra": {}
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for AAA server list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"secondaryRadiusPort": {
"type": "integer"
},
"adminDomainName": {
"type": "string"
},
"creatorUUID": {
"type": "string"
},
"secondaryRadiusIP": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"RADIUS",
"AD",
"LDAP",
"RADIUSAcct",
"TACACS"
]
},
"secondaryRadiusIPv6": {
"type": "string"
},
"radiusPort": {
"type": "integer"
},
"ipv6": {
"type": "string"
},
"modifiedDateTime": {
"type": "integer"
},
"authType": {
"type": "string",
"enum": [
"WSG",
"WLAN"
]
},
"radiusIP": {
"type": "string"
},
"radiusIPv6": {
"type": "string"
},
"key": {
"type": "string"
},
"id": {
"type": "string"
},
"tenantUUID": {
"type": "string"
},
"enableSecondaryRadius": {
"type": "integer"
},
"modifierUsername": {
"type": "string"
},
"ip": {
"type": "string"
},
"zoneUUID": {
"type": "string"
},
"domainId": {
"type": "string"
},
"tacacsService": {
"type": "string"
},
"port": {
"type": "integer"
},
"radiusRealm": {
"type": "string"
},
"domainName": {
"type": "string"
},
"name": {
"type": "string"
},
"isConflict": {
"type": "integer"
},
"createOn": {
"type": "integer"
},
"globalCatalog": {
"type": "boolean"
},
"windowsDomainName": {
"type": "string"
}
}
}
}
}
}
Query Authentication AAAServers ¶
POST/v6_1/query/services/aaaServer/auth
Query Authentication AAAServers with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"key": "fcdf29e1-e870-4950-a4df-57b80efb5811",
"type": "RADIUS",
"name": "aAAServer00001",
"description": null,
"authType": "WLAN",
"radiusRealm": "hinet.net",
"radiusIP": "172.17.1.1",
"radiusIPv6": null,
"radiusPort": 1812,
"secondaryRadiusIP": "172.18.16.1",
"secondaryRadiusIPv6": null,
"secondaryRadiusPort": 1111,
"enableSecondaryRadius": 1,
"isConflict": 0,
"tacacsService": null,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"ip": null,
"ipv6": null,
"port": null,
"adminDomainName": null,
"domainName": null,
"windowsDomainName": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createOn": 1484720653245,
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"globalCatalog": null,
"modifiedDateTime": 1484720653245,
"id": "fcdf29e1-e870-4950-a4df-57b80efb5811"
},
{
"key": "4d388f44-10dd-4563-91d7-5886ae0339a3",
"type": "RADIUS",
"name": "aAAServer00002",
"description": null,
"authType": "WLAN",
"radiusRealm": "hinet.net",
"radiusIP": "172.17.1.2",
"radiusIPv6": null,
"radiusPort": 1812,
"secondaryRadiusIP": "172.18.16.2",
"secondaryRadiusIPv6": null,
"secondaryRadiusPort": 1111,
"enableSecondaryRadius": 1,
"isConflict": 0,
"tacacsService": null,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"ip": null,
"ipv6": null,
"port": null,
"adminDomainName": null,
"domainName": null,
"windowsDomainName": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createOn": 1484720653245,
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"globalCatalog": null,
"modifiedDateTime": 1484720653245,
"id": "4d388f44-10dd-4563-91d7-5886ae0339a3"
}
],
"extra": {}
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for AAA server list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"secondaryRadiusPort": {
"type": "integer"
},
"adminDomainName": {
"type": "string"
},
"creatorUUID": {
"type": "string"
},
"secondaryRadiusIP": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"RADIUS",
"AD",
"LDAP",
"RADIUSAcct",
"TACACS"
]
},
"secondaryRadiusIPv6": {
"type": "string"
},
"radiusPort": {
"type": "integer"
},
"ipv6": {
"type": "string"
},
"modifiedDateTime": {
"type": "integer"
},
"authType": {
"type": "string",
"enum": [
"WSG",
"WLAN"
]
},
"radiusIP": {
"type": "string"
},
"radiusIPv6": {
"type": "string"
},
"key": {
"type": "string"
},
"id": {
"type": "string"
},
"tenantUUID": {
"type": "string"
},
"enableSecondaryRadius": {
"type": "integer"
},
"modifierUsername": {
"type": "string"
},
"ip": {
"type": "string"
},
"zoneUUID": {
"type": "string"
},
"domainId": {
"type": "string"
},
"tacacsService": {
"type": "string"
},
"port": {
"type": "integer"
},
"radiusRealm": {
"type": "string"
},
"domainName": {
"type": "string"
},
"name": {
"type": "string"
},
"isConflict": {
"type": "integer"
},
"createOn": {
"type": "integer"
},
"globalCatalog": {
"type": "boolean"
},
"windowsDomainName": {
"type": "string"
}
}
}
}
}
}
Query Accounting AAAServers ¶
POST/v6_1/query/services/aaaServer/acct
Query Accounting AAAServers with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"key": "fcdf29e1-e870-4950-a4df-57b80efb5811",
"type": "RADIUS",
"name": "aAAServer00001",
"description": null,
"authType": "WLAN",
"radiusRealm": "hinet.net",
"radiusIP": "172.17.1.1",
"radiusIPv6": null,
"radiusPort": 1812,
"secondaryRadiusIP": "172.18.16.1",
"secondaryRadiusIPv6": null,
"secondaryRadiusPort": 1111,
"enableSecondaryRadius": 1,
"isConflict": 0,
"tacacsService": null,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"ip": null,
"ipv6": null,
"port": null,
"adminDomainName": null,
"domainName": null,
"windowsDomainName": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createOn": 1484720653245,
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"globalCatalog": null,
"modifiedDateTime": 1484720653245,
"id": "fcdf29e1-e870-4950-a4df-57b80efb5811"
},
{
"key": "4d388f44-10dd-4563-91d7-5886ae0339a3",
"type": "RADIUS",
"name": "aAAServer00002",
"description": null,
"authType": "WLAN",
"radiusRealm": "hinet.net",
"radiusIP": "172.17.1.2",
"radiusIPv6": null,
"radiusPort": 1812,
"secondaryRadiusIP": "172.18.16.2",
"secondaryRadiusIPv6": null,
"secondaryRadiusPort": 1111,
"enableSecondaryRadius": 1,
"isConflict": 0,
"tacacsService": null,
"tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
"ip": null,
"ipv6": null,
"port": null,
"adminDomainName": null,
"domainName": null,
"windowsDomainName": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"createOn": 1484720653245,
"creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"modifierUsername": "admin",
"zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
"globalCatalog": null,
"modifiedDateTime": 1484720653245,
"id": "4d388f44-10dd-4563-91d7-5886ae0339a3"
}
],
"extra": {}
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for AAA server list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"secondaryRadiusPort": {
"type": "integer"
},
"adminDomainName": {
"type": "string"
},
"creatorUUID": {
"type": "string"
},
"secondaryRadiusIP": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"RADIUS",
"AD",
"LDAP",
"RADIUSAcct",
"TACACS"
]
},
"secondaryRadiusIPv6": {
"type": "string"
},
"radiusPort": {
"type": "integer"
},
"ipv6": {
"type": "string"
},
"modifiedDateTime": {
"type": "integer"
},
"authType": {
"type": "string",
"enum": [
"WSG",
"WLAN"
]
},
"radiusIP": {
"type": "string"
},
"radiusIPv6": {
"type": "string"
},
"key": {
"type": "string"
},
"id": {
"type": "string"
},
"tenantUUID": {
"type": "string"
},
"enableSecondaryRadius": {
"type": "integer"
},
"modifierUsername": {
"type": "string"
},
"ip": {
"type": "string"
},
"zoneUUID": {
"type": "string"
},
"domainId": {
"type": "string"
},
"tacacsService": {
"type": "string"
},
"port": {
"type": "integer"
},
"radiusRealm": {
"type": "string"
},
"domainName": {
"type": "string"
},
"name": {
"type": "string"
},
"isConflict": {
"type": "integer"
},
"createOn": {
"type": "integer"
},
"globalCatalog": {
"type": "boolean"
},
"windowsDomainName": {
"type": "string"
}
}
}
}
}
}
Query Clients ¶
POST/v6_1/query/client
Query clients with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"apMac": "58:B6:33:37:D4:E0",
"apName": "R710_Box_Up_Pink",
"hostname": "Nolan_DELL_Laptop",
"status": "AUTHORIZED",
"authStatus": "AUTHORIZED",
"alerts": null,
"osType": "Windows 7/Vista",
"ipAddress": "10.11.0.86",
"ipv6Address": "2001:b030:2516:164:7074:3f14:f0d9:c939",
"clientMac": "00:24:D7:89:36:A0",
"ssid": "NolanWPATest",
"txBytes": 2099158501,
"rxBytes": 73731395,
"txRxBytes": 2172889896,
"uplink": 73731395,
"downlink": 2099158501,
"traffic": 2172889896,
"uplinkRate": 131194,
"downlinkRate": 3735157,
"rssi": -47,
"snr": 58,
"radioType": "11a/n/ac",
"vlan": 1,
"channel": 36,
"userName": null,
"authMethod": "Standard+Open",
"encryptionMethod": "WPA2-AES",
"controlPlaneName": "node232",
"dataPlaneName": null,
"rxFrames": 952977,
"txFrames": 1729632,
"txDropDataFrames": 4,
"sessionStartTime": 1487400391000,
"speedflex": 0,
"wlanType": "0",
"zoneId": "d6ad32aa-c400-4005-b9c2-1d5b90e44139",
"zoneVersion": "3.5.0.99.1132"
},
{
"apMac": "74:3E:2B:35:ED:80",
"apName": "R700_ED:80_123",
"hostname": "mit-E5430",
"status": "AUTHORIZED",
"authStatus": "AUTHORIZED",
"alerts": null,
"osType": "Windows 7/Vista",
"ipAddress": "192.168.10.26",
"ipv6Address": "3075:100::d597:4368:1acf:49f3",
"clientMac": "24:77:03:E7:53:D0",
"ssid": "qa-mit-kpi-231",
"txBytes": 8336498864,
"rxBytes": 150640661,
"txRxBytes": 8487139525,
"uplink": 150640661,
"downlink": 8336498864,
"traffic": 8487139525,
"uplinkRate": 5589,
"downlinkRate": 309320,
"rssi": -32,
"snr": 80,
"radioType": "11g/n",
"vlan": 1,
"channel": 11,
"userName": null,
"authMethod": "Standard+Open",
"encryptionMethod": "WPA2-AES",
"controlPlaneName": "node232",
"dataPlaneName": null,
"rxFrames": 2830943,
"txFrames": 5936625,
"txDropDataFrames": 60315,
"sessionStartTime": 1487555453000,
"speedflex": 0,
"wlanType": "0",
"zoneId": "6d6c9cbb-45ba-48e4-a6c9-af28b286a507",
"zoneVersion": "3.5.0.99.1132"
}
]
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"extra": {
"description": "extra information for client list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"role": {
"type": "string"
},
"ipv6Address": {
"type": "string"
},
"clientMac": {
"type": "string"
},
"dataPlaneName": {
"type": "string"
},
"channel": {
"type": "integer"
},
"ssid": {
"type": "string"
},
"encryptionMethod": {
"type": "string"
},
"apName": {
"type": "string"
},
"traffic": {
"type": "integer"
},
"uplink": {
"type": "integer"
},
"downlink": {
"type": "integer"
},
"txRxBytes": {
"type": "integer"
},
"txDropDataFrames": {
"type": "integer"
},
"txFrames": {
"type": "integer"
},
"hostname": {
"type": "string"
},
"vlan": {
"type": "integer"
},
"controlPlaneName": {
"type": "string"
},
"rxFrames": {
"type": "integer"
},
"wlanType": {
"type": "string"
},
"osType": {
"type": "string"
},
"speedflex": {
"type": "integer"
},
"rssi": {
"type": "integer"
},
"rxBytes": {
"type": "integer"
},
"ipAddress": {
"type": "string"
},
"sessionStartTime": {
"type": "number"
},
"apMac": {
"type": "string"
},
"userName": {
"type": "string"
},
"alerts": {
"type": "integer"
},
"txBytes": {
"type": "integer"
},
"snr": {
"type": "integer"
},
"authMethod": {
"type": "string"
},
"radioType": {
"type": "string"
},
"status": {
"type": "string"
},
"zoneVersion": {
"type": "string"
},
"authStatus": {
"type": "string"
},
"uplinkRate": {
"type": "integer"
},
"downlinkRate": {
"type": "integer"
},
"zoneId": {
"type": "string"
},
"bssid": {
"type": "string"
}
}
}
}
}
}
Query DPSKs ¶
POST/v6_1/query/dpsk
Query DPSKs with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"extra": {
"rbacMetadata": [
{
"DEVICE_CATEGORY": "FULL_ACCESS"
}
]
},
"list": [
{
"key": "caa96db0-5c62-4559-8c38-669f31943ca8",
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneId": "6a61585a-2631-4086-b6cc-793470c419a1",
"wlanId": "3",
"userName": "BatchDPSK_User_0",
"ueMac": null,
"userRoleId": null,
"vlanId": null,
"group": false,
"expired": true,
"ttl": 172800,
"expirationStartTime": 1468921101,
"expirationTime": 1469093901,
"creationDateTime": 1469007501404
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"description": "extra information for DPSK list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"description": "Information list of DPSK",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"key": {
"description": "Identifier of DPSK",
"type": "string"
},
"tenantId": {
"description": "Tenant ID of DPSK",
"type": "string"
},
"domainId": {
"description": "Domain ID of DPSK",
"type": "string"
},
"zoneId": {
"description": "Zone ID of DPSK",
"type": "string"
},
"wlanId": {
"description": "WLAN ID of DPSK",
"type": "string"
},
"userName": {
"description": "User Name of DPSK",
"type": "string"
},
"ueMac": {
"description": "Mac address of DPSK",
"type": "string"
},
"userRoleId": {
"description": "Identity User Role ID of DPSK",
"type": "string"
},
"vlanId": {
"description": "VLAN ID of DPSK",
"type": "integer"
},
"group": {
"description": "Is a Group DPSK or not",
"type": "boolean"
},
"expired": {
"description": "DPSK is expired or not",
"type": "boolean"
},
"ttl": {
"description": "Time To Live of DPSK (Unit: Seconds)",
"type": "number"
},
"expirationStartTime": {
"description": "Expiration start time of DPSK (Unit: Seconds)",
"type": "number"
},
"expirationTime": {
"description": "Expiration time of DPSK (Unit: Seconds)",
"type": "number"
},
"createDateTime": {
"description": "Creationd time of DPSK",
"type": "number"
}
}
}
}
}
}
Retrieve user List ¶
POST/v6_1/query/user
Query users with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve Wlan Scheduler List ¶
POST/v6_1/query/services/wlanScheduler
Query Wlan Schedulers with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve wechat portal List ¶
POST/v6_1/query/services/wechatProfile
Query Wechat Portals with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve Web Authentication profile List ¶
POST/v6_1/query/services/webAuthentication
Query Web Authentications with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve Vlan Pooling Profile List ¶
POST/v6_1/query/services/vlanPooling
Query Vlan Pooling Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve Venue Profile List ¶
POST/v6_1/query/services/venueProfile
Query Venue Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve L2 AccessControl Profile List ¶
POST/v6_1/query/services/l2AccessControl
Query L2 AccessControl Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve Hotspot20 Profile List ¶
POST/v6_1/query/services/hotspot20Profile
Query Hotspot20 Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve Hotspot Profile List ¶
POST/v6_1/query/services/hotspot
Query Hotspot Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve Guess Access Profile List ¶
POST/v6_1/query/services/guessAccess
Query Guess Access Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve Ethernet Port Profile List ¶
POST/v6_1/query/services/ethernetPortProfile
Query Ethernet Port Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve DSCP Profile List ¶
POST/v6_1/query/services/dscpProfile
Query DSCP Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve DHCP Profile List ¶
POST/v6_1/query/services/dhcpProfile
Query DHCP Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "75e26590-547f-11e6-9ca7-5a095364c13c",
"name": "dppf_01",
"description": "dppf_01",
"vlanId": 10,
"subnetNetworkIp": "10.2.2.0",
"subnetMask": "255.255.255.0",
"poolStartIp": "10.2.2.1",
"poolEndIp": "10.2.2.254",
"primaryDnsIp": "2.2.2.2",
"secondaryDnsIp": "8.8.8.8",
"leaseTimeHours": 24,
"leaseTimeMinutes": 0
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 2,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
}
}
Retrieve Device Policy Profile List ¶
POST/v6_1/query/services/devicePolicy
Query Device Policy Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Query Rogue AP List ¶
POST/v6_1/query/roguesInfoList
Use this API command to retrieve a list of rogue access points. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"rawDataTotalCount": 100,
"totalCount": 10,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"detectedByAP": [
{
"apMac": "FF:FF:FF:FF:FF:FF",
"apName": "Dummy AP",
"rssi": "64",
"rogueType": "Rogue",
"lastDetected": 1470717826622,
"zoneName": "Zone1",
"mainDetector": true
}
],
"channel": 11,
"rogueMac": "DD:DD:DD:DD:DD:DD",
"encryption": "WPA",
"radio": "54",
"lastDetected": 1470717826622,
"ssid": "Dummy SSID",
"type": "AD_HOC",
"rogueAPMac": "EE:EE:EE:EE:EE:EE"
},
{
"detectedByAP": [
{
"apMac": "FF:FF:FF:FF:FF:FF",
"apName": "Dummy AP",
"rssi": "64",
"lastDetected": 1470717826622
}
],
"channel": 11,
"rogueMac": "DD:DD:DD:DD:DD:DD",
"encryption": "WPA",
"radio": "54",
"lastDetected": 1470717826622,
"ssid": "Dummy SSID",
"type": "AD_HOC",
"rogueAPMac": "EE:EE:EE:EE:EE:EE"
}
],
"extra": null
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"rawDataTotalCount" : {
"description" : "Total Rogue APs count.",
"type" : "integer"
},
"totalCount" : {
"description" : "Total Rogue APs count in this response.",
"type" : "integer"
},
"extra" : {
"description" : "Any additional response data.",
"type" : "object"
},
"hasMore" : {
"description" : "Indicator of whether there are more Rogue AP after the current displayed list",
"type" : "boolean"
},
"firstIndex" : {
"description" : "Index of the first Rogue AP returned out of the complete Rogue AP list",
"type" : "integer"
},
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"detectedByAP" : {
"description" : "The list of the AP found this Rogue AP.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"description" : "AP MAC of the rogue AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"apName" : {
"description" : "Name of the rogue AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"rssi" : {
"description" : "RSSI of the rogue AP",
"type" : "string"
},
"lastDetected" : {
"description" : "Timestamp of the AP",
"type" : "integer"
},
"zoneName" : {
"description" : "Zone name",
"type" : "string"
},
"rogueType" : {
"description" : "Rogue type",
"type" : "string"
},
"mainDetector" : {
"description" : "To identify whether this is main instance for UI",
"type" : "boolean"
}
}
}
},
"channel" : {
"description" : "Channel of the rogue AP",
"type" : "integer"
},
"rogueMac" : {
"description" : "Rogue MAC of the rogue AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"encryption" : {
"description" : "Encryption of the rogue AP",
"type" : "string"
},
"radio" : {
"description" : "Radio of the rogue AP",
"type" : "string"
},
"lastDetected" : {
"description" : "Timestamp of the rogue AP",
"type" : "integer"
},
"ssid" : {
"description" : "SSID of the rogue AP",
"type" : "string"
},
"type" : {
"description" : "Type of the rogue AP",
"type" : "string"
},
"rogueAPMac" : {
"description" : "Rogue AP MAC of the rogue AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"classification" : {
"description" : "Rogue classification by policy",
"type" : "string"
},
"matchResult" : {
"description" : "What policy and rule matched when system doing classification by rogue policy",
"type" : "string"
}
}
}
}
}
}
Query Mesh Neighbor AP List ¶
POST/v6_1/query/mesh/{apMac}/neighbor
Use this API command to retrieve a list of neighbor access points on mesh AP. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"rawDataTotalCount": 100,
"totalCount": 10,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"apMac": "AB:CD:00:00:00:02",
"apName": "AP003",
"ipAddress": "192.168.0.234",
"externalIPAddress": "10.10.10.1:2000",
"apModel": "R500",
"apFirmware": "3.5.0.102.79",
"channel": "108(a/g)",
"connectionStatus": "Disconnect",
"rssi": 56
}
],
"extra": null
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "MeshNeighborInfos count.",
"type": "integer"
},
"totalCount": {
"description": "MeshNeighborInfos count in this response.",
"type": "integer"
},
"extra": {
"description": "Any additional response data.",
"type": "object"
},
"hasMore": {
"description": "Indicator of whether there are more MeshNeighborInfo after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first MeshNeighborInfo returned out of the complete Rogue AP list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"description": "The MAC of the neighbor AP",
"type": "string"
},
"apName": {
"description": "The name of the neighbor AP",
"type": "string"
},
"ipAddress": {
"description": "The IP of the neighbor AP",
"type": "string"
},
"externalIPAddress": {
"description": "The external IP of the neighbor AP",
"type": "string"
},
"apModel": {
"description": "The model of the neighbor AP",
"type": "string"
},
"apFirmware": {
"description": "The firmware of the neighbor AP",
"type": "string"
},
"channel": {
"description": "The channel of the neighbor AP",
"type": "string"
},
"connectionStatus": {
"description": "The connection status of the neighbor AP",
"type": "string"
},
"rssi": {
"description": "The RSSI of the neighbor AP",
"type": "integer"
},
"zoneName": {
"description": "The zone name of the neighbor AP",
"type": "string"
}
}
}
}
}
}
Retrieve bonjourPolicy Profile List ¶
POST/v6_1/query/services/bonjourPolicy
Query bonjourPolicy Profiles with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Retrieve indoorMap List ¶
POST/v6_1/query/indoorMap
Query indoorMap with specified filters. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
"name": "testMap",
"description": "",
"imageFileName": "^B7DD96DBDEDD273F0AE10E2BC49F394D6F6A972EA001F73854^pimgptestMap.png",
"address": "apg1map",
"longitude": 121.56999969482422,
"latitude": 25.06999969482422,
"apGroupId": "0f7acc6c-1777-4c05-8b9c-2f88df5bad4b",
"zoneId": "c8fb596b-a87c-4d97-a18c-df21d5bae631",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"groupType": "APGROUP",
"scale": {
"a": {
"x": 411,
"y": 187.390625
},
"b": {
"x": 356,
"y": 189.390625
},
"distance": 11,
"unit": "MM"
},
"apCount": 0
}
],
"extra": {
"rbacMetadata": [
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
},
{
"AP_CATEGORY": "FULL_ACCESS"
}
]
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total indoor maps count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more indoor maps after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first indoorMapList returned out of the complete indoor maps list",
"type": "integer"
},
"extra": {
"description": "extra information for indoor map",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "id",
"type": "string"
},
"key": {
"description": "id",
"type": "string"
},
"zoneId": {
"description": "zoneId",
"type": "string"
},
"apCount": {
"description": "AP count in this indoor map",
"type": "number"
},
"name": {
"description": "name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"address": {
"description": "address",
"type": "string"
},
"imageFileName": {
"description": "imageFileName",
"type": "string"
},
"latitude": {
"description": "latitude",
"type": "number"
},
"longitude": {
"description": "longitude",
"type": "number"
},
"groupType": {
"description": "group Type",
"enum": [
"SYSTEM",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP"
]
},
"domainId": {
"description": "domainId",
"type": "string"
},
"tenantId": {
"description": "tenantId",
"type": "string"
},
"scale": {
"description": "scale",
"type": "object",
"additionalProperties": false,
"properties": {
"a": {
"description": "point a",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"b": {
"description": "point b",
"type": "object",
"additionalProperties": false,
"properties": {
"x": {
"description": "x",
"type": "number"
},
"y": {
"description": "y",
"type": "number"
}
}
},
"distance": {
"description": "distance",
"type": "number"
},
"unit": {
"description": "unit",
"enum": [
"MM",
"CM",
"M",
"Foot",
"Yard"
]
}
}
},
"apGroupId": {
"description": "apGroupId",
"type": "string"
}
},
"required": [
"name",
"description",
"groupType"
]
}
}
}
}
Retrieve AP Wlan list with BSSID information by QueryCriteria ¶
POST/v6_1/query/ap/wlan
Use this API command to retrieve AP Wlan list with BSSID information by QueryCriteria Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"rawDataTotalCount": 1,
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"apMac": "38:FF:36:12:F1:90",
"deviceName": "RuckusAP",
"wlanBssids": [
{
"wlanName": "wlanA",
"bssid": "38:FF:36:12:F1:98",
"wlanId": 1,
"radioId": 0
},
{
"wlanName": "wlanB",
"bssid": "38:FF:36:52:F1:98",
"wlanId": 2,
"radioId": 0
},
{
"wlanName": "wlanC",
"bssid": "38:FF:36:92:F1:98",
"wlanId": 3,
"radioId": 0
},
{
"wlanName": "wlanD",
"bssid": "38:FF:36:D2:F1:98",
"wlanId": 4,
"radioId": 0
},
{
"wlanName": "wlanE",
"bssid": "38:FF:36:12:F1:99",
"wlanId": 5,
"radioId": 0
},
{
"wlanName": "wlanF",
"bssid": "38:FF:36:52:F1:99",
"wlanId": 6,
"radioId": 0
},
{
"wlanName": "wlanG",
"bssid": "38:FF:36:92:F1:99",
"wlanId": 7,
"radioId": 0
},
{
"wlanName": "wlanA",
"bssid": "38:FF:36:12:F1:9C",
"wlanId": 1,
"radioId": 1
},
{
"wlanName": "wlanB",
"bssid": "38:FF:36:52:F1:9C",
"wlanId": 2,
"radioId": 1
},
{
"wlanName": "wlanC",
"bssid": "38:FF:36:92:F1:9C",
"wlanId": 3,
"radioId": 1
},
{
"wlanName": "wlanD",
"bssid": "38:FF:36:D2:F1:9C",
"wlanId": 4,
"radioId": 1
},
{
"wlanName": "wlanE",
"bssid": "38:FF:36:12:F1:9D",
"wlanId": 5,
"radioId": 1
},
{
"wlanName": "wlanF",
"bssid": "38:FF:36:52:F1:9D",
"wlanId": 6,
"radioId": 1
},
{
"wlanName": "wlanG",
"bssid": "38:FF:36:92:F1:9D",
"wlanId": 7,
"radioId": 1
}
]
}
],
"extra": null
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "Index of first index in current page",
"type": "integer"
},
"hasMore": {
"description": "Has more data or not",
"type": "boolean"
},
"totalCount": {
"description": "Total matched AP count",
"type": "integer"
},
"extra": {
"description": "extra information",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
}
}
}
}
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"apMac": {
"type": "string"
},
"deviceName": {
"type": "string"
},
"wlanBssids": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"wlanName": {
"type": "string"
},
"bssid": {
"type": "string"
},
"wlanId": {
"type": "integer"
},
"radioId": {
"type": "integer"
}
}
}
}
}
}
}
}
}
Event and Alarm ¶
Retrieve Event List ¶
POST/v6_1/alert/event/list
Query Events with specified filters.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
},
{
"type": "CATEGORY",
"value": "Cluster"
},
{
"type": "CATEGORY",
"value": "Control_Plane"
},
{
"type": "CATEGORY",
"value": "Data_Plane"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "insertionTime",
"dir": "DESC"
},
"page": 7,
"limit": 10
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"rawDataTotalCount": 287,
"totalCount": 287,
"hasMore": true,
"firstIndex": 70,
"list": [
{
"id": "AVpeTrTUyxBWfBW4Kn0G",
"insertionTime": 1487640900817,
"eventType": "Memory threshold exceeded",
"eventCode": 951,
"severity": "Critical",
"activity": "Memory threshold [89.73%] exceeded on control plane [ui206-C].",
"category": "Control_Plane"
},
{
"id": "AVpeNCpZyxBWfBW4Kn0F",
"insertionTime": 1487639161431,
"eventType": "AP health high airtime utilization clear",
"eventCode": 348,
"severity": "Informational",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] cleared 2.4GHz} airtime utilization health [24], which is no longer past the threshold [70].",
"category": "AP"
},
{
"id": "AVpeLMFFyxBWfBW4Kn0E",
"insertionTime": 1487638675779,
"eventType": "AP channel updated",
"eventCode": 306,
"severity": "Informational",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11a/n] and has switched from channel [157] to channel [149].",
"category": "AP"
},
{
"id": "AVpeLMDHyxBWfBW4Kn0D",
"insertionTime": 1487638675652,
"eventType": "AP channel updated",
"eventCode": 306,
"severity": "Informational",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11g/n] and has switched from channel [6] to channel [8].",
"category": "AP"
},
{
"id": "AVpeFfOZyxBWfBW4Kn0C",
"insertionTime": 1487637181335,
"eventType": "AP health high airtime utilization flag",
"eventCode": 347,
"severity": "Warning",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] flagged 2.4GHz} airtime utilization health [79] because it crossed the threshold [70].",
"category": "AP"
},
{
"id": "AVpeEUcsyxBWfBW4Kn0B",
"insertionTime": 1487636875050,
"eventType": "AP channel updated",
"eventCode": 306,
"severity": "Informational",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11a/n] and has switched from channel [149] to channel [157].",
"category": "AP"
},
{
"id": "AVpeCB5wyxBWfBW4Kn0A",
"insertionTime": 1487636274798,
"eventType": "AP channel updated",
"eventCode": 306,
"severity": "Informational",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11g/n] and has switched from channel [8] to channel [6].",
"category": "AP"
},
{
"id": "AVpd-UR7yxBWfBW4Knz_",
"insertionTime": 1487635301493,
"eventType": "Cluster application started",
"eventCode": 817,
"severity": "Informational",
"activity": "Application [Scheduler] on node [ui206] started.",
"category": "Cluster"
},
{
"id": "AVpd9c3XyxBWfBW4Knz-",
"insertionTime": 1487635074516,
"eventType": "AP channel updated",
"eventCode": 306,
"severity": "Informational",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11a/n] and has switched from channel [157] to channel [149].",
"category": "AP"
},
{
"id": "AVpdzoqwyxBWfBW4Knz9",
"insertionTime": 1487632501419,
"eventType": "AP health high airtime utilization clear",
"eventCode": 348,
"severity": "Informational",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] cleared 2.4GHz} airtime utilization health [62], which is no longer past the threshold [70].",
"category": "AP"
}
],
"extra": null
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"activity": {
"type": "string"
},
"category": {
"type": "string"
},
"eventCode": {
"type": "integer"
},
"eventType": {
"type": "string"
},
"id": {
"type": "string"
},
"insertionTime": {
"type": "number"
},
"severity": {
"type": "string"
}
}
}
},
"rawDataTotalCount": {
"description": "",
"type": "integer"
}
}
}
Retrieve Alarm List ¶
POST/v6_1/alert/alarm/list
Query Alarms with specified filters.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
},
{
"type": "CATEGORY",
"value": "Cluster"
},
{
"type": "CATEGORY",
"value": "Control_Plane"
},
{
"type": "CATEGORY",
"value": "Data_Plane"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "insertionTime",
"dir": "DESC"
},
"page": 1,
"limit": 10
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME"
]
},
"value": {
"description": "value to search",
"type": "string"
},
"operator": {
"description": "operator",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled"
]
},
"value": {
"description": "value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
]
},
"acct_type": {
"description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not.",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not.",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query.",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query.",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query.",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
},
"localUser_auditTime": {
"description": "Audit time of local users",
"type": "object",
"properties": {
"start": {
"description": "start time for auditTime",
"type": "number"
},
"end": {
"description": "end time for auditTime",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"localUser_firstName": {
"description": "First name of local users",
"type": "string"
},
"localUser_lastName": {
"description": "Last name of local users",
"type": "string"
},
"localUser_mailAddress": {
"description": "Mail address of local users",
"type": "string"
},
"localUser_primaryPhoneNumber": {
"description": "Primary phone number of local users",
"type": "string"
},
"localUser_displayName": {
"description": "Display name of local users",
"type": "string"
},
"localUser_userName": {
"description": "User name of local users",
"type": "string"
},
"localUser_userSource": {
"description": "User source of local users",
"type": "string"
},
"localUser_subscriberType": {
"description": "Subscriber type of local users",
"type": "string"
},
"localUser_status": {
"description": "Status of local users",
"type": "string"
},
"guestPass_displayName": {
"description": "Display name of guest pass",
"type": "string"
},
"guestPass_expiration": {
"description": "Expiration time of guest pass",
"type": "object",
"properties": {
"start": {
"description": "start time of expiration",
"type": "number"
},
"end": {
"description": "end time of expiration",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
}
}
},
"guestPass_wlan": {
"description": "WLAN which used by quest pass",
"type": "string"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"rawDataTotalCount": 3,
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "Alarm_951_00:0C:29:93:00:00",
"insertionTime": 1487670600858,
"alarmType": "Memory threshold exceeded",
"alarmCode": 951,
"alarmState": "Cleared",
"severity": "Critical",
"activity": "Memory threshold [95.15%] exceeded on control plane [ui206-C].",
"acknowledged": "No",
"ackTime": null,
"ackUser": null,
"category": "Control_Plane",
"clearComment": "Auto Cleared",
"clearTime": 1487671200984,
"clearUser": "System"
},
{
"id": "Alarm_303_94:F6:65:3C:93:C0",
"insertionTime": 1487666250201,
"alarmType": "AP disconnected",
"alarmCode": 303,
"alarmState": "Cleared",
"severity": "Major",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] disconnected.",
"acknowledged": "Yes",
"ackTime": 1487735042472,
"ackUser": "admin",
"category": "AP",
"clearComment": "test bulk clear",
"clearTime": 1487735127383,
"clearUser": "admin"
},
{
"id": "AVpG_G6RyxBWfBW4KnsQ",
"insertionTime": 1487249632908,
"alarmType": "AP rebooted by system",
"alarmCode": 302,
"alarmState": "Cleared",
"severity": "Major",
"activity": "AP [RuckusAP@94:F6:65:3C:93:C0] rebooted by the system because of [application, wsgclient, reboot due to firmware change ].",
"acknowledged": "Yes",
"ackTime": 1487735042514,
"ackUser": "admin",
"category": "AP",
"clearComment": "test bulk clear",
"clearTime": 1487735127377,
"clearUser": "admin"
}
],
"extra": null
}
Schema
{
"additionalProperties": false,
"type": "object",
"properties": {
"firstIndex": {
"description": "",
"type": "integer"
},
"hasMore": {
"description": "",
"type": "boolean"
},
"totalCount": {
"description": "",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"additionalProperties": "false",
"type": "object",
"properties": {
"ackTime": {
"type": "number"
},
"ackUser": {
"type": "string"
},
"acknowledged": {
"type": "string"
},
"activity": {
"type": "string"
},
"alarmCode": {
"type": "integer"
},
"alarmState": {
"type": "string"
},
"alarmType": {
"type": "string"
},
"category": {
"type": "string"
},
"clearComment": {
"type": "string"
},
"clearTime": {
"type": "number"
},
"clearUser": {
"type": "string"
},
"id": {
"type": "string"
},
"insertionTime": {
"type": "number"
},
"severity": {
"type": "string"
}
}
}
},
"rawDataTotalCount": {
"description": "",
"type": "integer"
}
}
}
Acknowledge Alarm ¶
Clear Alarm ¶
Acknowledge Alarms ¶
PUT/v6_1/alert/alarm/ack
Acknowledge multiple Alarms with provided alarmIDs.
Body
{
"idList": [
"Alarm_303_AB:CD:00:00:00:17",
"Alarm_303_AB:CD:00:00:00:21"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
204
Clear Alarms ¶
PUT/v6_1/alert/alarm/clear
Clear multiple Alarms with provided alarmIDs.
Body
{
"idList": [
"Alarm_303_AB:CD:00:00:00:17",
"Alarm_303_AB:CD:00:00:00:21"
],
"comment": ""
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
},
"comment": {
"description": "Comment for clearing alarm",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
}
}
}
204
Cluster Management ¶
System configuration backup ¶
POST/v6_1/configuration/backup
Backup system configuration.
201
Body
{
"id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the create object",
"type": "string"
}
}
}
System configuration restore ¶
POST/v6_1/configuration/restore/{id}
Restore system configuration with specified backupUUID.
204
Retrieve List ¶
GET/v6_1/configuration
Retrive system configuration list.
- 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
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "b9c6e66e-f436-402f-a8b1-004d0b9ec7d8",
"createdOn": "2015/04/29 16:27:13",
"scgVersion": "3.2.0.0.71",
"controlPlaneSoftwareVersion": "3.2.0.0.56",
"dataPlaneSoftwareVersion": "0.0.0.0",
"createdBy": "admin",
"type": "1",
"backupElapsed": null,
"fileSize": 40026
},
{
"id": "b0d4df4d-c8eb-4738-ae45-ce73bf936f34",
"createdOn": "2015/04/29 16:48:32",
"scgVersion": "3.2.0.0.71",
"controlPlaneSoftwareVersion": "3.2.0.0.56",
"dataPlaneSoftwareVersion": "0.0.0.0",
"createdBy": "admin",
"type": "1",
"backupElapsed": null,
"fileSize": 40053
}
]
}
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 system configuration backup file.",
"type": "string"
},
"createdOn": {
"description": "the create time of the configuration backup file.",
"type": "number"
},
"scgVersion": {
"description": "SCG version of the configuration backup file.",
"type": "string"
},
"controlPlaneSoftwareVersion": {
"description": "control plane software version of the configuration backup file",
"type": "string"
},
"dataPlaneSoftwareVersion": {
"description": "data plane software version of the configuration backup file",
"type": "string"
},
"createdBy": {
"description": "creator of the configuration backup file.",
"type": "string"
},
"type": {
"description": "type of the configuration backup file",
"type": "string"
},
"backupElapsed": {
"description": "backup elapsed of the configuration backup file",
"type": "number"
},
"fileSize": {
"description": "file size of the backup file",
"type": "number"
},
"md5": {
"description": "file md5 of the backup file",
"type": "string"
}
}
}
}
}
}
Get Auto Export Backup ¶
GET/v6_1/configurationSettings/autoExportBackup
Get Auto Export Backup Settings.
200
Body
{
"enableAutoExportBackup": true,
"ftpServer": "FTP server name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enableAutoExportBackup": {
"description": "enable auto export backup",
"type": "boolean"
},
"ftpServer": {
"description": "FTP server name",
"type": "string"
}
}
}
Get Schedule Backup Setting ¶
GET/v6_1/configurationSettings/scheduleBackup
Get Schedule Backup Setting.
200
Body
{
"enableScheduleBackup": true,
"interval": "MONTHLY",
"dateOfMonth": 5,
"hour": 2,
"minute": 15
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enableScheduleBackup": {
"description": "enable schedule backup",
"type": "boolean"
},
"interval": {
"description": "schedule interval",
"enum": [
"MONTHLY",
"WEEKLY",
"DAILY"
]
},
"dayOfWeek": {
"description": "day of the week",
"enum": [
"SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY"
]
},
"dateOfMonth": {
"description": "date of the month",
"type": "integer"
},
"hour": {
"description": "hour",
"type": "integer"
},
"minute": {
"description": "minute",
"type": "integer"
}
}
}
Modify Auto Export Backup ¶
PATCH/v6_1/configurationSettings/autoExportBackup
Modify Auto Export Backup Settings.
Body
{
"enableAutoExportBackup": true,
"ftpServer": "FTP server name"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enableAutoExportBackup": {
"description": "enable auto export backup",
"type": "boolean",
"default": false
},
"ftpServer": {
"description": "ftp server name",
"type": "string"
}
}
}
204
Modify Schedule Backup Setting ¶
PATCH/v6_1/configurationSettings/scheduleBackup
Modify Schedule Backup Setting.
Body
{
"enableScheduleBackup": true,
"interval": "WEEKLY",
"dayOfWeek": "MONDAY",
"hour": 2,
"minute": 15
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"enableScheduleBackup": {
"description": "enable schedule backup",
"type": "boolean",
"default": false
},
"interval": {
"description": "schedule interval",
"enum": [
"MONTHLY",
"WEEKLY",
"DAILY"
]
},
"dayOfWeek": {
"description": "day of the week",
"enum": [
"SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY"
]
},
"dateOfMonth": {
"description": "date of the month",
"type": "integer"
},
"hour": {
"description": "hour",
"type": "integer",
"default": 0
},
"minute": {
"description": "minute",
"type": "integer",
"default": 0
}
}
}
204
Download ¶
GET/v6_1/configuration/download
Download system configuration file.
- backupUUID
string
(required)System configuration file uuid
- timeZone
string
(optional)DEPRECATED Time zone
200
Upload File ¶
POST/v6_1/upgrade/upload
Use this API command to upload patch file.
200
Body
{
"clusterOperationProgress": {
"operation": "None",
"overallProgress": 0,
"isSelfBladeRebooting": null,
"bladeProgresss": [
{
"bladeUUID": "386988fe-72fe-41e0-a373-7a73fea5d16e",
"hostName": "neilscg200",
"iterationName": "None",
"state": "",
"progress": 0
}
],
"previousOperationRecord": {
"operation": "Upload",
"success": true,
"errorMsg": null
},
"clusterSubTaskState": "Completed",
"clusterOperationBlockUI": false,
"clusterOperationDisplayMsg": ""
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"clusterOperationProgress": {
"description": "upgrade status",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of clusterOperationProgress",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"overallProgress": {
"description": "overallProgress of clusterOperationProgress",
"type": "integer"
},
"isSelfBladeRebooting": {
"description": "isSelfBladeRebooting of clusterOperationProgress",
"type": "boolean"
},
"bladeProgresss": {
"description": "bladeProgressMap of clusterOperationProgress",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"bladeUUID": {
"description": "bladeUUID of bladeProgress",
"type": "string"
},
"hostName": {
"description": "hostName of bladeProgress",
"type": "string"
},
"iterationName": {
"description": "iterationName of bladeProgress",
"type": "string"
},
"state": {
"description": "state of bladeProgress",
"type": "string"
},
"progress": {
"description": "progress of bladeProgress",
"type": "integer"
}
}
}
},
"previousOperationRecord": {
"description": "previousOperationRecord of clusterOperationProgress",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of previousOperationRecord",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"success": {
"description": "success of previousOperationRecord",
"type": "boolean"
},
"errorMsg": {
"description": "errorMsg of previousOperationRecord",
"type": "string"
}
}
},
"clusterSubTaskState": {
"description": "clusterSubTaskState of clusterOperationProgress",
"enum": [
"None",
"Running",
"Failed",
"Completed"
]
},
"clusterOperationBlockUI": {
"description": "clusterOperationBlockUI of clusterOperationProgress",
"type": "boolean"
},
"clusterOperationDisplayMsg": {
"description": "clusterOperationDisplayMsg of clusterOperationProgress",
"type": "string"
}
}
}
}
}
Retrive Cluster Progress Status ¶
GET/v6_1/upgrade/status
Use this API command to retrive cluster progress status.
200
Body
{
"clusterOperationProgress": {
"operation": "None",
"overallProgress": 0,
"isSelfBladeRebooting": null,
"bladeProgresss": [
{
"bladeUUID": "386988fe-72fe-41e0-a373-7a73fea5d16e",
"hostName": "neilscg200",
"iterationName": "None",
"state": "",
"progress": 0
}
],
"previousOperationRecord": {
"operation": "Upload",
"success": true,
"errorMsg": null
},
"clusterSubTaskState": "Completed",
"clusterOperationBlockUI": false,
"clusterOperationDisplayMsg": ""
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"clusterOperationProgress": {
"description": "upgrade status",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of clusterOperationProgress",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"overallProgress": {
"description": "overallProgress of clusterOperationProgress",
"type": "integer"
},
"isSelfBladeRebooting": {
"description": "isSelfBladeRebooting of clusterOperationProgress",
"type": "boolean"
},
"bladeProgresss": {
"description": "bladeProgressMap of clusterOperationProgress",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"bladeUUID": {
"description": "bladeUUID of bladeProgress",
"type": "string"
},
"hostName": {
"description": "hostName of bladeProgress",
"type": "string"
},
"iterationName": {
"description": "iterationName of bladeProgress",
"type": "string"
},
"state": {
"description": "state of bladeProgress",
"type": "string"
},
"progress": {
"description": "progress of bladeProgress",
"type": "integer"
}
}
}
},
"previousOperationRecord": {
"description": "previousOperationRecord of clusterOperationProgress",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of previousOperationRecord",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"success": {
"description": "success of previousOperationRecord",
"type": "boolean"
},
"errorMsg": {
"description": "errorMsg of previousOperationRecord",
"type": "string"
}
}
},
"clusterSubTaskState": {
"description": "clusterSubTaskState of clusterOperationProgress",
"enum": [
"None",
"Running",
"Failed",
"Completed"
]
},
"clusterOperationBlockUI": {
"description": "clusterOperationBlockUI of clusterOperationProgress",
"type": "boolean"
},
"clusterOperationDisplayMsg": {
"description": "clusterOperationDisplayMsg of clusterOperationProgress",
"type": "string"
}
}
}
}
}
Retrive Upload Patch Info ¶
GET/v6_1/upgrade/patch
Use this API command to retrive upload file Info.
200
Body
{
"clusterOperationProgress": {
"operation": "None",
"overallProgress": 0,
"isSelfBladeRebooting": null,
"bladeProgresss": [
{
"bladeUUID": "386988fe-72fe-41e0-a373-7a73fea5d16e",
"hostName": "neilscg200",
"iterationName": "None",
"state": "",
"progress": 0
}
],
"previousOperationRecord": {
"operation": "Upload",
"success": true,
"errorMsg": null
},
"clusterSubTaskState": "Completed",
"clusterOperationBlockUI": false,
"clusterOperationDisplayMsg": ""
},
"uploadPatchInfo": {
"fileName": "scg-installer_3.2.1.0.2.ximg",
"fileSize": 893545600,
"fileUploadPath": null,
"controlbladeVersion": "3.2.1.0.4",
"allowVersions": null,
"databladeVersion": "3.2.1.0.6",
"apVersion": "3.2.1.99.528",
"version": "3.2.1.0.2"
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"clusterOperationProgress": {
"description": "upgrade status",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of clusterOperationProgress",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"overallProgress": {
"description": "overallProgress of clusterOperationProgress",
"type": "integer"
},
"isSelfBladeRebooting": {
"description": "isSelfBladeRebooting of clusterOperationProgress",
"type": "boolean"
},
"bladeProgresss": {
"description": "bladeProgressMap of clusterOperationProgress",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"bladeUUID": {
"description": "bladeUUID of bladeProgress",
"type": "string"
},
"hostName": {
"description": "hostName of bladeProgress",
"type": "string"
},
"iterationName": {
"description": "iterationName of bladeProgress",
"type": "string"
},
"state": {
"description": "state of bladeProgress",
"type": "string"
},
"progress": {
"description": "progress of bladeProgress",
"type": "integer"
}
}
}
},
"previousOperationRecord": {
"description": "previousOperationRecord of clusterOperationProgress",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of previousOperationRecord",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"success": {
"description": "success of previousOperationRecord",
"type": "boolean"
},
"errorMsg": {
"description": "errorMsg of previousOperationRecord",
"type": "string"
}
}
},
"clusterSubTaskState": {
"description": "clusterSubTaskState of clusterOperationProgress",
"enum": [
"None",
"Running",
"Failed",
"Completed"
]
},
"clusterOperationBlockUI": {
"description": "clusterOperationBlockUI of clusterOperationProgress",
"type": "boolean"
},
"clusterOperationDisplayMsg": {
"description": "clusterOperationDisplayMsg of clusterOperationProgress",
"type": "string"
}
}
},
"uploadPatchInfo": {
"description": "upgrade patch info",
"type": "object",
"additionalProperties": false,
"properties": {
"fileName": {
"description": "fileName of uploadPatchInfo",
"type": "string"
},
"fileSize": {
"description": "fileSize of uploadPatchInfo",
"type": "number"
},
"fileUploadPath": {
"description": "fileUploadPath of uploadPatchInfo",
"type": "string"
},
"controlbladeVersion": {
"description": "controlbladeVersion of uploadPatchInfo",
"type": "string"
},
"databladeVersion": {
"description": "databladeVersion of uploadPatchInfo",
"type": "string"
},
"apVersion": {
"description": "apVersion of uploadPatchInfo",
"type": "string"
},
"version": {
"description": "version of uploadPatchInfo",
"type": "string"
},
"allowVersions": {
"description": "allowVersions of uploadPatchInfo",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
System Upgrade ¶
POST/v6_1/upgrade
Use this API command to do system upgrade.
200
Body
{
"clusterOperationProgress": {
"operation": "None",
"overallProgress": 0,
"isSelfBladeRebooting": null,
"bladeProgresss": [
{
"bladeUUID": "386988fe-72fe-41e0-a373-7a73fea5d16e",
"hostName": "neilscg200",
"iterationName": "None",
"state": "",
"progress": 0
}
],
"previousOperationRecord": {
"operation": "Upload",
"success": true,
"errorMsg": null
},
"clusterSubTaskState": "Completed",
"clusterOperationBlockUI": false,
"clusterOperationDisplayMsg": ""
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"clusterOperationProgress": {
"description": "upgrade status",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of clusterOperationProgress",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"overallProgress": {
"description": "overallProgress of clusterOperationProgress",
"type": "integer"
},
"isSelfBladeRebooting": {
"description": "isSelfBladeRebooting of clusterOperationProgress",
"type": "boolean"
},
"bladeProgresss": {
"description": "bladeProgressMap of clusterOperationProgress",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"bladeUUID": {
"description": "bladeUUID of bladeProgress",
"type": "string"
},
"hostName": {
"description": "hostName of bladeProgress",
"type": "string"
},
"iterationName": {
"description": "iterationName of bladeProgress",
"type": "string"
},
"state": {
"description": "state of bladeProgress",
"type": "string"
},
"progress": {
"description": "progress of bladeProgress",
"type": "integer"
}
}
}
},
"previousOperationRecord": {
"description": "previousOperationRecord of clusterOperationProgress",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of previousOperationRecord",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"success": {
"description": "success of previousOperationRecord",
"type": "boolean"
},
"errorMsg": {
"description": "errorMsg of previousOperationRecord",
"type": "string"
}
}
},
"clusterSubTaskState": {
"description": "clusterSubTaskState of clusterOperationProgress",
"enum": [
"None",
"Running",
"Failed",
"Completed"
]
},
"clusterOperationBlockUI": {
"description": "clusterOperationBlockUI of clusterOperationProgress",
"type": "boolean"
},
"clusterOperationDisplayMsg": {
"description": "clusterOperationDisplayMsg of clusterOperationProgress",
"type": "string"
}
}
}
}
}
Retrive Upgrade History ¶
GET/v6_1/upgrade/history
Use this API command to retrive upgrade history.
- 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
- timezone
string
(optional)
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"startTime": "2015/10/15 02:48:38",
"version": "3.2.1.0.1",
"cbVersion": "3.2.1.0.20151014063356",
"dpVersion": "3.2.1.0.20",
"apFwVersion": "3.2.1.99.537",
"oldVersion": "3.2.1.0.1",
"oldCbVersion": "3.2.1.0.20151014063356",
"oldDpVersion": "3.2.1.0.20",
"oldApFwVersion": "3.2.1.99.537",
"fileName": "Fresh Installation",
"elapsedSeconds": 772
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"startTime": {
"description": "startTime of the upgrade history",
"type": "string"
},
"version": {
"description": "version of the upgrade history",
"type": "string"
},
"cbVersion": {
"description": "cbVersion of the upgrade history",
"type": "string"
},
"dpVersion": {
"description": "dpVersion of the upgrade history",
"type": "string"
},
"apFwVersion": {
"description": "apFwVersion of the upgrade history",
"type": "string"
},
"oldVersion": {
"description": "oldVersion of the upgrade history",
"type": "string"
},
"oldCbVersion": {
"description": "oldCbVersion of the upgrade history",
"type": "string"
},
"oldDpVersion": {
"description": "oldDpVersion of the upgrade history",
"type": "string"
},
"oldApFwVersion": {
"description": "oldApFwVersion of the upgrade history",
"type": "string"
},
"fileName": {
"description": "fileName of the upgrade history",
"type": "string"
},
"elapsedSeconds": {
"description": "elapsedSeconds of the upgrade history",
"type": "number"
}
}
}
}
}
}
Upload AP Patch File ¶
Retrive Uploaded AP Patch File Info ¶
GET/v6_1/apPatch
Use this API command to retrive uploaded AP patch file info.
200
Body
{
"fileName": "scg-ap-3.6.1.0-6.noarch.patch",
"fileSize": 79673580,
"apVersion": "3.6.1.0.6",
"apModels": [
"C110",
"C500",
"FZM300",
"FZP300",
"H320",
"H500",
"H510",
"R300",
"R310",
"R500",
"R500E",
"R510",
"R600",
"R610",
"R700",
"R710",
"R720",
"T300",
"T300E",
"T301N",
"T301S",
"T504",
"T610",
"T610S",
"T710",
"T710S",
"ZF7055",
"ZF7352",
"ZF7372",
"ZF7372-E",
"ZF7781CM",
"ZF7782",
"ZF7782-E",
"ZF7782-N",
"ZF7782-S",
"ZF7982"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"fileName": {
"description": "file name of the upload file",
"type": "string"
},
"fileSize": {
"description": "file size(Byte) of the upload file",
"type": "integer"
},
"apVersion": {
"description": "ApFwVersion of the upload file",
"type": "string"
},
"apModels": {
"description": "AP Models of the upload file",
"type": "array",
"items": {
"type": "string"
}
}
}
}
Apply AP Patch ¶
POST/v6_1/apPatch
Use this API command to apply AP patch.
200
Body
{
"clusterOperationProgress": {
"operation": "None",
"overallProgress": 0,
"previousOperationRecord": {
"operation": "UploadAPFirmware",
"success": true,
"errorMsg": null
}
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"clusterOperationProgress": {
"description": "AP Apply status",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of clusterOperationProgress",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"overallProgress": {
"description": "overallProgress of clusterOperationProgress",
"type": "integer"
},
"previousOperationRecord": {
"description": "previousOperationRecord of clusterOperationProgress",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of previousOperationRecord",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"success": {
"description": "success of previousOperationRecord",
"type": "boolean"
},
"errorMsg": {
"description": "errorMsg of previousOperationRecord",
"type": "string"
}
}
}
}
}
}
}
Retrive AP Patch Cluster Progress Status ¶
GET/v6_1/apPatch/status
Use this API command to retrive cluster progress status.
200
Body
{
"clusterOperationProgress": {
"operation": "None",
"overallProgress": 0,
"previousOperationRecord": {
"operation": "UploadAPFirmware",
"success": true,
"errorMsg": null
}
}
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"clusterOperationProgress": {
"description": "AP Apply status",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of clusterOperationProgress",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"overallProgress": {
"description": "overallProgress of clusterOperationProgress",
"type": "integer"
},
"previousOperationRecord": {
"description": "previousOperationRecord of clusterOperationProgress",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"description": "operation of previousOperationRecord",
"enum": [
"None",
"Join",
"Backup",
"Restore",
"Upload",
"Upgrade",
"BackupAndUpgrade",
"RemoveBlade",
"ChangeBladeIP",
"DiskSnapshot",
"UploadVDPFirmware",
"UploadAPFirmware",
"AddAPFirmware"
]
},
"success": {
"description": "success of previousOperationRecord",
"type": "boolean"
},
"errorMsg": {
"description": "errorMsg of previousOperationRecord",
"type": "string"
}
}
}
}
}
}
}
Retrive AP Patch History ¶
GET/v6_1/apPatch/history
Use this API command to retrive AP patch history.
- 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
- timezone
string
(optional)
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"startDateTime": "2017/10/16 01:43:35",
"fileName": "scg-ap-3.6.1.0-23.noarch.patch",
"apFwVersion": "3.6.1.0.23",
"apModelList": [
"C110",
"C500",
"FZM300",
"FZP300",
"H320",
"H500",
"H510",
"R300",
"R310",
"R500",
"R500E",
"R510",
"R600",
"R610",
"R700",
"R710",
"R720",
"T300",
"T300E",
"T301N",
"T301S",
"T504",
"T610",
"T610S",
"T710",
"T710S",
"ZF7055",
"ZF7352",
"ZF7372",
"ZF7372-E",
"ZF7781CM",
"ZF7782",
"ZF7782-E",
"ZF7782-N",
"ZF7782-S",
"ZF7982"
]
},
{
"startDateTime": "2017/10/13 10:23:21",
"fileName": "scg-ap-3.6.1.0-6.noarch.patch",
"apFwVersion": "3.6.1.0.6",
"apModelList": [
"C110",
"C500",
"FZM300",
"FZP300",
"H320",
"H500",
"H510",
"R300",
"R310",
"R500",
"R500E",
"R510",
"R600",
"R610",
"R700",
"R710",
"R720",
"T300",
"T300E",
"T301N",
"T301S",
"T504",
"T610",
"T610S",
"T710",
"T710S",
"ZF7055",
"ZF7352",
"ZF7372",
"ZF7372-E",
"ZF7781CM",
"ZF7782",
"ZF7782-E",
"ZF7782-N",
"ZF7782-S",
"ZF7982"
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"startDateTime": {
"description": "startDateTime of the AP Patch history",
"type": "string"
},
"fileName": {
"description": "file name of the AP Patch history",
"type": "string"
},
"apFwVersion": {
"description": "apFwVersion of the AP Patch history",
"type": "string"
},
"apModelList": {
"description": "AP Models of the AP Patch history",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
Cluster Status ¶
GET/v6_0/cluster/status
Use this API command to get Cluster Status.
Deprecated : this URI will be deprecated after Version: v6_0, not support.Not recommended to use this URI, please use /cluster/state instead
200
Body
{
"clusterStatus": "In_Service"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"clusterStatus": {
"description": "progress of bladeProgress",
"enum": [
"In_Service",
"Out_Of_Service",
"Maintenance",
"Read_Only",
"NetworkPartitionSuspected"
]
}
}
}
Control node Status ¶
GET/v6_0/cluster/nodeStatus
Use this API command to get Control node Status.
Deprecated : this URI will be deprecated after Version: v6_0, not support.Not recommended to use this URI, please use /cluster/state instead
200
Body
{
"nodeStatusList": [
{
"nodeId": "f339e900-f24d-4bbc-ad40-4a66925f0ed4",
"nodeStatus": "In_Service"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"nodeStatusList": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"nodeId": {
"description": "Identifier of the controller node",
"type": "string"
},
"nodeStatus": {
"description": "node status",
"enum": [
"Out_Of_Service",
"Bootstrapping",
"Got_WSG_Version",
"WSG_FW_Upgrading",
"Initializing_Database",
"Syncing_Configurations",
"Changing_Configurations",
"Launching_Apps",
"In_Service",
"Shutting_Down_Apps"
]
}
}
}
}
}
}
Retrieve List ¶
GET/v6_1/cluster
Retrive cluster backup list.
- 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
- timezone
string
(optional)Change display timezone of created date and time, like timezone=Asia/Taipei, default is UTC time.
200
Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "20150907031120_3.2.0.0.721",
"version": "3.2.0.0.721",
"filesize": "998.4 MB",
"createdOn": "2015/09/07 11:11:20"
}
]
}
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 cluster backup file.",
"type": "string"
},
"version": {
"description": "the patch version of the cluster backup file.",
"type": "string"
},
"filesize": {
"description": "filesize of the cluster backup file.",
"type": "number"
},
"createdOn": {
"description": "Created date and time of the cluster backup file",
"type": "string"
}
}
}
}
}
}
Get Cluster Redundancy ¶
GET/v6_1/cluster/geoRedundancy
Get cluster redundancy settings.
200
Body
{
"clusterRedundancyEnabled": true,
"managementEntryList": [
{
"ip": "172.17.18.145",
"port": "8443"
}
],
"scheduleSyncUpEnabled": true,
"hour": 6
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"clusterRedundancyEnabled": {
"description": "Cluster redundancy enabled",
"type": "boolean"
},
"managementEntryList": {
"description": "Management entry list of backup cluster",
"type": "array",
"properties": {
"ip": {
"description": "Management IP",
"type": "string"
},
"port": {
"description": "Management port",
"type": "string"
}
}
},
"scheduleSyncUpEnabled": {
"description": "Scheduled configuration sync enabled",
"type": "boolean"
},
"hour": {
"description": "Schedule sync time in daily hour (0-23)",
"type": "integer"
}
}
}
Get current cluster state ¶
GET/v6_1/cluster/state
Use this API command to get current cluster, blade, and management service states
200
Body
{
"clusterState": "In_Service",
"nodeStateList": [
{
"nodeId": "01f89f76-175a-43b1-931f-c2c82dc673a7",
"nodeState": "In_Service"
},
{
"nodeId": "b6d06d5b-0927-4dc1-8590-1b01dfb8a402",
"nodeState": "In_Service"
}
],
"managementServiceStateList": [
{
"nodeId": "01f89f76-175a-43b1-931f-c2c82dc673a7",
"managementServiceState": "In_Service"
},
{
"nodeId": "b6d06d5b-0927-4dc1-8590-1b01dfb8a402",
"managementServiceState": "In_Service"
}
]
}
Schema
{
"type": "object",
"properties": {
"clusterState": {
"description": "cluster state",
"enum": [
"In_Service",
"Out_Of_Service",
"Maintenance",
"Read_Only",
"NetworkPartitionSuspected"
]
},
"nodeStateList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"description": "Identifier of the controller node",
"type": "string"
},
"nodeState": {
"description": "node state",
"enum": [
"Out_Of_Service",
"In_Service"
]
}
}
}
},
"managementServiceStateList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"description": "Identifier of the controller node",
"type": "string"
},
"managementServiceState": {
"description": "management service state",
"enum": [
"Out_Of_Service",
"In_Service"
]
}
}
}
}
}
}
Account Security ¶
Delete the account security profile by id ¶
DELETE/v6_1/accountSecurity/{id}
Use this API command to delete the account security profile by id.
Body
{
"id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile id",
"type": "string"
}
}
}
200
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile id",
"type": "string"
},
"name": {
"description": "Profile name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
Create the account security profile. ¶
POST/v6_1/accountSecurity
Use this API command to create the account security proile.
Body
{
"name": "sample",
"description": "Test",
"accountLockout": 6,
"lockoutDuration": 30,
"passwordExpiration": 90,
"passwordReuse": 4
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Profile name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"accountLockout": {
"description": "The number of successive failures before a lockout will occur.",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"lockoutDuration": {
"description": "The duration for which the account is automatically locked without administrative intervention.",
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"passwordExpiration": {
"description": "A simple timer that forces the administrator to change their password regularly.",
"type": "integer",
"minimum": 1,
"maximum": 365
},
"passwordReuse": {
"description": "A validation the prevents reuse of the same password(s).",
"type": "integer",
"minimum": 1,
"maximum": 6
},
"domainId": {
"description": "Domain id",
"type": "string"
}
}
}
200
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile id",
"type": "string"
},
"name": {
"description": "Profile name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
Get the account security profile by id ¶
GET/v6_1/accountSecurity/{id}
Use this API command to retrieve the specific account security profile.
Body
{
"id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile id",
"type": "string"
},
"name": {
"description": "accountSecurityProfile.getById.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
200
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "accountSecurityProfile.getByIdResult.properties.id.description",
"type": "string"
},
"name": {
"description": "accountSecurityProfile.getByIdResult.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "accountSecurityProfile.getByIdResult.properties.description.description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"domainId": {
"description": "accountSecurityProfile.getByIdResult.properties.domainId.description",
"type": "string"
},
"tenantId": {
"description": "accountSecurityProfile.getByIdResult.properties.tenantId.description",
"type": "string"
},
"accountLockout": {
"description": "accountSecurityProfile.getByIdResult.properties.accountLockout.description",
"type": "integer"
},
"lockoutDuration": {
"description": "accountSecurityProfile.getByIdResult.properties.lockoutDuration.description",
"type": "integer"
},
"passwordExpiration": {
"description": "accountSecurityProfile.getByIdResult.properties.passwordExpiration.description",
"type": "integer"
},
"passwordReuse": {
"description": "accountSecurityProfile.getByIdResult.properties.passwordReuse.description",
"type": "integer"
}
}
}
Get the account security profiles ¶
GET/v6_1/accountSecurity
Use this API command to get account security profiles.
200
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": "Profile id",
"type": "string"
},
"name": {
"description": "accountSecurityProfile.getById.properties.name.description",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
}
}
}
Modify ¶
PATCH/v6_1/accountSecurity/{id}
Use this API command to modify the specific account security profile.
Body
{
"name": "sample",
"description": "Test",
"accountLockout": 5,
"lockoutDuration": 20,
"passwordExpiration": 100,
"passwordReuse": 6
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Profile name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"accountLockout": {
"description": "The number of successive failures before a lockout will occur.",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"lockoutDuration": {
"description": "The duration for which the account is automatically locked without administrative intervention.",
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"passwordExpiration": {
"description": "A simple timer that forces the administrator to change their password regularly.",
"type": "integer",
"minimum": 1,
"maximum": 365
},
"passwordReuse": {
"description": "A validation the prevents reuse of the same password(s).",
"type": "integer",
"minimum": 1,
"maximum": 6
},
"domainId": {
"description": "accountSecurityProfile.update.properties.domainId.description",
"type": "string"
}
}
}
200
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile id",
"type": "string"
},
"name": {
"description": "Profile name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
Modify the account security profile ¶
PUT/v6_1/accountSecurity/{id}
Use this API command to modify the specific account security profile.
Body
{
"name": "sample",
"description": "Test",
"accountLockout": 5,
"lockoutDuration": 20,
"passwordExpiration": 100,
"passwordReuse": 6
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Profile name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description",
"type": [
"string",
"null"
],
"maxLength": 64
},
"accountLockout": {
"description": "The number of successive failures before a lockout will occur.",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"lockoutDuration": {
"description": "The duration for which the account is automatically locked without administrative intervention.",
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"passwordExpiration": {
"description": "A simple timer that forces the administrator to change their password regularly.",
"type": "integer",
"minimum": 1,
"maximum": 365
},
"passwordReuse": {
"description": "A validation the prevents reuse of the same password(s).",
"type": "integer",
"minimum": 1,
"maximum": 6
},
"domainId": {
"description": "accountSecurityProfile.update.properties.domainId.description",
"type": "string"
}
}
}
200
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Profile id",
"type": "string"
},
"name": {
"description": "Profile name",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
}
}
}
Delete the account security profile ¶
DELETE/v6_1/accountSecurity
Use this API command to selete the account security profile.
Body
{
"idList": [
"eac50e51-4a63-11e7-a68a-0a0027000000",
"1b4950d1-49d9-11e7-a68a-0a0027000000"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
200
Data Plane ¶
DP Network ¶
Retrieve List ¶
GET/v6_1/planes
Use this API command to retrieve a list of data planes.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "24:C9:A1:3F:10:60",
"bladeName": "test63-D0",
"mac": "24:C9:A1:3F:10:60",
"ip": null,
"ipv6": null,
"fwVersion": null,
"model": null,
"serialNumber": null,
"dpStatus": "Disconnected",
"lastSeen": null,
"uptime": "0s",
"greTunnels": 0,
"managedBy": null,
"type": "External - V"
},
{
"id": "24:C9:A1:3F:10:68",
"bladeName": "test63-D1",
"mac": "24:C9:A1:3F:10:68",
"ip": null,
"ipv6": null,
"fwVersion": null,
"model": null,
"serialNumber": null,
"dpStatus": "Disconnected",
"lastSeen": null,
"uptime": "0s",
"greTunnels": 0,
"managedBy": null,
"type": "External - V"
}
]
}
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 data plane",
"type": "string"
},
"name": {
"description": "Name of the data plane",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"mac": {
"description": "DP MAC Address",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"ipv6": {
"description": "IP address of ipv6",
"type": "string"
},
"managedBy": {
"description": "Managed By",
"type": "string"
},
"model": {
"description": "Model",
"type": "string"
},
"serialNumber": {
"description": "Serial Number",
"type": "string"
},
"greTunnels": {
"description": "# of Ruckus GRE Tunnels",
"type": "string"
},
"fwVersion": {
"description": "Firmware",
"type": "string"
},
"lastSeen": {
"description": "Last Seen On",
"type": "string"
},
"dpStatus": {
"description": "Status",
"type": "string"
},
"uptime": {
"description": "Uptime",
"type": "string"
},
"type": {
"description": "Type",
"type": "string"
}
}
}
}
}
}
Retrieve ¶
GET/v6_1/planes/{bladeUUID}
Use this API command to retrieve data plane by id.
200
Body
{
"interfaceMode": "ACCESS_AND_CORE",
"primaryInterface": {
"ipMode": "STATIC",
"ipAddress": "192.168.1.0",
"subnetMask": "255.255.255.0",
"gateway": "192.168.1.0",
"primaryDNSServer": "2.2.2.2",
"secondaryDNSServer": "5.5.5.5",
"vlan": "22",
"natIp": "10.2.3.10"
},
"secondaryInterface": {
"ipAddress": "192.168.10.1",
"subnetMask": "255.255.255.0",
"vlan": "123"
},
"ipv6PrimaryInterface": {
"ipMode": "STATIC",
"ipAddress": "2222:3333::5555/64",
"gateway": "2222:3333::0000",
"primaryDNSServer": "2222:3333::5555",
"secondaryDNSServer": "2222:3333::2222"
},
"staticRoute": [
{
"networkAddress": "255.255.255.0",
"subnetMask": "255.255.255.0",
"gateway": "192.168.10.15"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"interfaceMode": {
"description": "Interface mode",
"enum": [
"SINGLE",
"ACCESS_AND_CORE"
]
},
"primaryInterface": {
"description": "Primary(Access) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
},
"vlan": {
"description": "Vlan",
"type": "string"
},
"natIp": {
"description": "NAT IP",
"type": "string"
}
}
},
"ipv6PrimaryInterface": {
"description": "IPv6 Primary(Access) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
},
"secondaryInterface": {
"description": "Secondary (Core) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"vlan": {
"description": "vlan",
"type": "string"
}
}
},
"staticRoute": {
"description": "Primary(Access) interface",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "Network address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
},
"required": [
"networkAddress",
"subnetMask",
"gateway"
]
}
},
"keepConfig": {
"description": "system.dataPlaneConfiguration.properties.keepConfig.description",
"type": "boolean"
}
}
}
Modify ¶
PATCH/v6_1/planes/{bladeUUID}
Use this API command to modify the basic information of data plane.
Body
{
"interfaceMode": "ACCESS_AND_CORE",
"primaryInterface": {
"ipMode": "STATIC",
"ipAddress": "192.168.1.0",
"subnetMask": "255.255.255.0",
"gateway": "192.168.1.0",
"primaryDNSServer": "2.2.2.2",
"secondaryDNSServer": "5.5.5.5",
"vlan": "22",
"natIp": "10.2.3.10"
},
"ipv6PrimaryInterface": {
"ipMode": "STATIC",
"ipAddress": "2222:3333::5555/64",
"gateway": "2222:3333::0000",
"primaryDNSServer": "2222:3333::5555",
"secondaryDNSServer": "2222:3333::2222"
},
"secondaryInterface": {
"ipAddress": "192.168.10.1",
"subnetMask": "255.255.255.0",
"vlan": "123"
},
"staticRoute": [
{
"networkAddress": "255.255.255.0",
"subnetMask": "255.255.255.0",
"gateway": "192.168.10.15"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"interfaceMode": {
"description": "Interface mode",
"enum": [
"SINGLE",
"ACCESS_AND_CORE"
]
},
"primaryInterface": {
"description": "Primary(Access) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
},
"vlan": {
"description": "Vlan",
"type": "string"
},
"natIp": {
"description": "NAT IP",
"type": "string"
}
}
},
"ipv6PrimaryInterface": {
"description": "IPv6 Primary(Access) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
},
"secondaryInterface": {
"description": "Secondary (Core) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"vlan": {
"description": "vlan",
"type": "string"
}
}
},
"staticRoute": {
"description": "Primary(Access) interface",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "Network address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
},
"required": [
"networkAddress",
"subnetMask",
"gateway"
]
}
},
"keepConfig": {
"description": "system.modifyDataPlane.properties.keepConfig.description",
"type": "boolean"
}
}
}
204
Modify Primary Interface ¶
PATCH/v6_1/planes/{bladeUUID}/primaryInterface
Use this API command to modify primary interface of data plane.
Body
{
"ipMode": "STATIC",
"ipAddress": "192.168.1.0",
"subnetMask": "255.255.255.0",
"gateway": "192.168.1.0",
"primaryDNSServer": "2.2.2.2",
"secondaryDNSServer": "5.5.5.5",
"vlan": "22",
"natIp": "10.2.3.10"
}
Schema
{
"description": "Primary(Access) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"DHCP"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
},
"vlan": {
"description": "Vlan",
"type": "string"
},
"natIp": {
"description": "NAT IP",
"type": "string"
}
}
}
204
Modify ipv6 Primary Interface ¶
PATCH/v6_1/planes/{bladeUUID}/ipv6PrimaryInterface
Use this API command to modify ipv6 Primary Interface of data plane.
Body
{
"ipMode": "STATIC",
"ipAddress": "2222:3333::5555/64",
"gateway": "2222:3333::0000",
"primaryDNSServer": "2222:3333::5555",
"secondaryDNSServer": "2222:3333::2222"
}
Schema
{
"description": "IPv6 Primary(Access) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipMode": {
"description": "IP mode",
"enum": [
"STATIC",
"AUTO"
]
},
"ipAddress": {
"description": "IP address",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
},
"primaryDNSServer": {
"description": "Primary DNS server",
"type": "string"
},
"secondaryDNSServer": {
"description": "Secondary DNS server",
"type": "string"
}
}
}
204
Modify Secondary Interface ¶
PATCH/v6_1/planes/{bladeUUID}/secondaryInterface
Use this API command to modify secondary interface of data plane.
Body
{
"ipAddress": "192.168.10.1",
"subnetMask": "255.255.255.0",
"vlan": "123"
}
Schema
{
"description": "Secondary (Core) Interface",
"type": "object",
"additionalProperties": false,
"properties": {
"ipAddress": {
"description": "IP address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"vlan": {
"description": "vlan",
"type": "string"
}
}
}
204
Modify Static Route ¶
PATCH/v6_1/planes/{bladeUUID}/staticRoute
Use this API command to modify static route of data plane.
Body
[
{
"networkAddress": "255.255.255.0",
"subnetMask": "255.255.255.0",
"gateway": "192.168.10.15"
}
]
Schema
{
"description": "Primary(Access) interface",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"networkAddress": {
"description": "Network address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"gateway": {
"description": "Gateway",
"type": "string"
}
},
"required": [
"networkAddress",
"subnetMask",
"gateway"
]
}
}
204